Releases: tianhaoz95/readable-readme
Readable Readme v0.1.3 with experimental ignore config feature
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
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
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!
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 😃