Your README.txt does not follow best practices (headings need to be uppercase). See https://www.drupal.org/node/2181737 .
The CONFIGURATION section is missing.

CommentFileSizeAuthor
#2 readme_file_updated-3119340-2.patch354 bytesrksyravi

Comments

rksyravi created an issue. See original summary.

rksyravi’s picture

rksyravi
Primary language Hindi
Location New Delhi, 🇮🇳
commented
Assigned: rksyravi » Unassigned
Status: Active » Needs review
StatusFileSize
new readme_file_updated-3119340-2.patch354 bytes

This patch will help to resolve. Please review it.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
Status: Needs review » Needs work

Marking NW, as CONFIGURATION should instead have some additional text on how the module shows itself when there is no configuration.

Please see https://www.drupal.org/docs/develop/documenting-your-project/readme-temp... for more information and an example.

I also recommend adjusting the spacing per the Quick formatting tips: https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

  • temkin committed e61dc69 on 8.x-1.x 
    Issue #3119340 by rksyravi, Webbeh, temkin: README.txt does not follow...
temkin’s picture

temkin commented
Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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