If README is not readable, nothing else will be.

Too often we find a great project, but give up 5 minutes later only because we can't get enough information from its README. I wouldn't blame the developers for the poor README readability because, first, unlike the code, there has never been a focus on README readability, and second, there is no good tools to enforce README readability.

The readable-readme project aim to build a GitHub action that checks the readability of README files and generate reports to help improve it.

Add the following code into your workflow steps:

- uses: actions/checkout@v1
- name: Readable Readme
  uses: tianhaoz95/[email protected]
  with:
    token: your_github_token_from_secrets

note: the token is used to post analyze report as GitHub issues.

Also, check out the documentation.

Any contribution is greatly appreciated. Please check out the guide for more details.