Utilize the README.txt file for the project description

Updating version to 2.1.x-dev.

Merged into 2.0.x (and not 2.1.x) because the issue fork was created before the 2.1.x-dev release was created, so there was no choice (lesson learned).

I manually added the changes to the README.md file to the 2.1.x branch directly (and pushed).

-mike

This change seems to have undone a lot of the changes from 📌 Update README.md file according to "README.md template" Fixed .

The document no longer follows the recommended pattern in the readme template → .

There are several issues with this version. First it doesn't start with the title as required. It is missing some required sections. It also has an oddly titled "Getting starting" heading, followed by a "Getting started" subheading further down.

It looks like the version in this commit may have been based off an older version, and got merged over the version in 📌 Update README.md file according to "README.md template" Fixed .

As 3330771 seems to follow the recommended template, I would recommend using it as the basis, and merge in any needed changes from this commit.

Not sure if this issue should be reopened, or a new one opened.

@lostcarpark,

Thanks for pointing out the README stuff in comment 7. Rather than re-opening this one, I'm going to propose some updates as part of 📌 Add "getting started" section to documentation Active .

-mike

@lostcarpark,

Thanks for your feedback.

One thing that the README template doesn't take into account is the fact that drupal.org projects have a "Copy README.md or README.txt file to the description" checkbox available to project maintainers. In my opinion, this makes it much easier to keep both the project page and README file up-to-date and in-sync.

Since (IMHO) this is a minor issue, I went ahead and made some updates to the README file (starting with fixing "Getting Starting" which I cannot believe both @markie and I missed!) and committed the changes directly to the 2.1.x branch (and have updated the project page to match).

The updated README has all of the required sections of the suggested template, but also adds a few additional sections.

thanks,
-mike

Automatically closed - issue fixed for 2 weeks with no activity.