While evaluating this module, while it has a readme, - I noticed the readme could use some helpful links and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Patch to follow, thanks!

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new2.44 KB

  • boromino committed db126c3 on 8.x-1.x authored by alonaoneill
    Issue #3068801 by alonaoneill: Existing README needs some formating
    
boromino’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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