Per https://www.drupal.org/node/2181737 , the README.MD needs edits to be in line with README best practices.

Specifically, from a cursory glance:
* Module name is not needed in README.md.
* CONFIGURATION section is missing.
* Standardization of header formatting and sapcing.
* Hard-wrap lines per best-practices.

CommentFileSizeAuthor
#4 readme-3112817-4.patch1.72 KBdeaom
#2 readme-3112817-2.patch1.4 KBdeaom

Comments

Webbeh created an issue. See original summary.

deaom’s picture

deaom commented
Status: Active » Needs review
StatusFileSize
new readme-3112817-2.patch1.4 KB

Patch is attached.

Webbeh’s picture

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

Everything looks fine per #2, except to hard-wrap lines at 80characters.

https://www.drupal.org/node/2181737#s-quick-formatting-tips
> Text manually word-wrapped within around 80 cols.

deaom’s picture

deaom commented
Status: Needs work » Needs review
StatusFileSize
new readme-3112817-4.patch1.72 KB

Yes, just noticed that. Here is the patch that also corrects that.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
Status: Needs review » Reviewed & tested by the community

Looks good to me. RTBC.

  • benjamincizej committed 9a1f8ce on 8.x-1.x authored by DeaOm 
    Issue #3112817 by DeaOm, Webbeh: README.MD does not follow best...
bcizej’s picture

bcizej commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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