Readable Readme v1.0.4-beta

Bug fixing

Readable Readme v1.0.3-beta

What's new:

• fix .readmeignore bug
• fix wording for report issue
• add a few tests
• fix the wrong author id
• add default ignore list

Hotfix:

• fix bug when .readmeignore not exist

Readable Readme v1.0.2-beta

What's new:

• fix .readmeignore bug
• fix wording for report issue
• add a few tests
• fix the wrong author id
• add default ignore list

Hotfix:

• fix bug when .readmeignore not exist

Readable Readme v1.0.1-beta

What's new:

• fix .readmeignore bug
• fix wording for report issue
• add a few tests
• fix the wrong author id

Hotfix:

• fix bug when .readmeignore not exist

Readable Readme v1.0.0-beta

What's new:

• fix .readmeignore bug
• fix wording for report issue
• add a few tests
• fix the wrong author id

Readable Readme v1.0.0-alpha

All features planned for the initial release are complete!
Enjoy error-free READMEs! 😃😃😃

Readable Readme v0.1.7 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.6 Hot fix:

• Change the build release because I was stupid.

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

Readable Readme v0.1.6 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.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

Readable Readme v0.1.5 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.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

Readable Readme v0.1.4 with better logging

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