While evaluating this module, while it has a readme, I noticed the readme could use some helpful links, configurations, and should be re-formatted to align with Drupal documentation standards.
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

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
StatusFileSize
new5.37 KB

I uploaded a patch that adds some useful information and reformatted the README. I also changed the extension to .md from .txt to utilize markdown for code blocks.

Thanks!

alonaoneill’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on module!