Update README.txt

I spent far more time than I'm willing to admit trying to work through the very issue you mentioned.

As a short term fix, may just a mention at the top of the readme that the module has evolved quite a bit since the readme was last updated, and to check online for the most recent documentation, here: https://www.drupal.org/documentation/modules/fivestar

?

I marked #3136011: Update README as a duplicate. Here's my comment from that issue:

Yes, it looks like the content in README.txt is mostly untouched since the port to Drupal 6. I don't think it all has to be fixed at the same time - I think that would be a little ambitious because I don't think everything is even working in Drupal 8 yet so there's no "new" text we can write for those things.

Also, some of this probably belong in the documentation guide and not the README any longer. In fact, a quick glance at https://www.drupal.org/docs/7/modules/fivestar (this is the D7 documentation) shows that a lot of this information IS in the documentation guide.

We can leave this issue open and post patches for individual sections of the README.

This'll also be a good chance to bring over what parts of D7 still apply to D8 documentation, as it's currently empty: https://www.drupal.org/docs/8/modules/fivestar

Kicking off this with a patch, which has rewritten the README up to the beginning of CONFIGURATION in line with README template: https://www.drupal.org/node/2181737

Given that the CONFIGURATION was pretty heavy-handed in the D6/D7 README, should we continue that verbosity in Drupal 8? Or, to the point of #2, would it be better to provide high-level overview of D8 features and leave more technical or process-driven steps to the (non-existent for D8) documentation?

Patch #4 looks pretty good so far. No, we do not need the detailed installation steps - those are a holdover from the D5/D6 days. In D8 there are many different ways to install a module so we should leave it up to core Drupal to explain that. If you don't know how to install a module, this is not the place to learn - replacing this with a link like you did is the right thing to do.

Things like providing a new set of star widgets in your own custom module should be in the documentation guide, not in the README.txt, although a link to the documentation guide would be nice. But before removing that make sure that the information is really there in the documentation guide. For widget sets, it's there in D7 - check that the D7 information is accurate. In D8, we're currently trying to make this feature work in D8, as it was never completely ported. See #3136366: hook_fivestar_widgets() implementations should explicitly include their associated libraries. Once that task is complete we can document it, but it's premature to have anything more than a placeholder in the D8 documentation for that at this time.

A lot of the changes you are making should also be made to the D7 README.txt. The D7 and D8 README.txt are identical except for a few spelling corrections and line wrapping changes made recently. I will backport those recent changes to D7. When posting patches it would be convenient if you would make separate patches for changes that should be in both D7 and D8 vs changes that should be make in D8 only, that way it will be easier to backport your fixes.

OK, I made the backport of coding standards fixes to D7 README.txt. The D7 and D8 versions are now identical.

When posting patches it would be convenient if you would make separate patches for changes that should be in both D7 and D8 vs changes that should be make in D8 only, that way it will be easier to backport your fixes.

Of course - I'd be happy to. This makes sense and should knock out the fixes on both branches, and is easy enough to do.

I made a couple of small changes to update the paths. And I restored the "Contributing" and "Support" sections. The only thing D8-specific to this patch is the path to the documentation guide - I can change that when I cherry-pick the commit to D7.

Committed #9 to the 7.x-2.x and 8.x-1.x branches. Leaving this open for further work.

Converting Readme.txt file into Readme.md file for a better format. #3341861: Replace README.txt with README.md

https://www.drupal.org/project/fivestar/issues/3341861

@arunkumark If you want to help please help improve the documentation. Changing the format of incorrect documentation does not help anything. Also, please search the issue queue before you post a new issue - this has been addressed several times already.

Created MR !25.

@ravi kant: Can you please describe what is in the MR? Is it anything more than a move from .txt to .md? Did you improve the documentation or add any documentation?

Hi @TR

I am following REAME Template standard.

That didn't answer my question.

Is it just a change in format?

Yes @heddn @TR
I made changes just in format only.

Please read what I wrote in #15. Changing the format doesn't really help anything.

But improving and/or correcting the documentation guide at https://www.drupal.org/docs/contributed-modules/fivestar (everyone has access), or working on the *contents* of the README would be appreciated.

@TR
The Readme file was having mix content of Drupal-7 and Drupal-8-9-10.
I worked for Drupal 8 branch so removed Drupal-7 configurations from this Branch.
Also i try to update according me.