Skip to content

Releases: tianhaoz95/readable-readme

Readable Readme v0.1.3 with experimental ignore config feature

30 Sep 19:50
f484be8
Compare
Choose a tag to compare

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.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

Readable Readme v0.1.2 with hot fixes

29 Sep 08:04
5e18c3a
Compare
Choose a tag to compare

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.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

Readable Readme v0.1.1 with hot fixes

29 Sep 07:41
Compare
Choose a tag to compare

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 😃

Hot fix:

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

First release of readable-readme!

28 Sep 06:51
3e31a91
Compare
Choose a tag to compare

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 😃