Skip to content

Readable Readme v0.1.6 with hot fixes

Pre-release
Pre-release
Compare
Choose a tag to compare
@tianhaoz95 tianhaoz95 released this 13 Nov 22:00
· 494 commits to master since this release
b82a9a0

The automated README readability tests.

This version of readable-readme only uses a naive English linter to point out simple readability issues. More functionalities will be added later 😃

v0.1.6 Hot fix:

  • Proceed with all files if ignore list is empty instead of error out.

v0.1.5 Hot fix:

  • Fix bug where when ignore list is empty, nothing gets linted

v0.1.4 Update:

  • Better logging capability.

v0.1.3 Update:

  • Add experimental feature to use a config file to ignore README files that are not valuable to analyze.

v0.1.2 Hot fix:

  • Add node_modules to source control as GitHub suggested.
  • Add tag refs matcher to avoid unknown refs error in tests.

v0.1.1 Hot fix:

  • Check compiled JS into source control
  • Fix documentation broken url
  • Fix broken test caused by tag refs