Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.0.7 (2018-05-01)

Dependency Updates

jest-runner-eslint: remove unused library (a68be53)

2.0.6 (2018-05-01)

Dependency Updates

ajv-keywords: update to version 3.2.0 (8be7236)

2.0.5 (2018-04-27)

Dependency Updates

codacy-coverage: update to v3.0.0 (3892fc5)
codacy-coverage: update to version 3.0.0 (6990e17)
lint-staged: update to version 7.0.5 (5c257cd)

2.0.2 (2018-04-26)

Dependency Updates

lint-staged: update to version 7.0.5 (5c257cd)

2.0.1 (2018-04-24)

Bug Fixes

config: move .env files (2ff8905), closes #23

2.0.0 (2018-04-21)

Dependency Updates

@semantic-release/git: update to version 4.0.2 (ad96ea5)

Bug Fixes

score: verify appraisal initialization (fd87a8b), closes #18 #21

BREAKING CHANGES

readme-score: ReadmeScore is now ReadmeAppraisal, with two method signatures changes and one property name change.

Objects & Properties

readmeInspector.ReadmeScore - refactor:rename ReadmeScore → ReadmeAppraisal, which is now a class.

Functions

readmeInspector.getReadmeInfo → readmeInspector.getInfo
- Refactor:rename function
- Refactor function signature: now expects a params object literal
readmeInspector.getReadmeScore → readmeInspector.getAppraisal

Refactor:rename function; signature remains the same as in 1.x.x, however.
readmeInspector.check's signature now expects a params object literal, which it passes to getInfo.

API tests

Add API (integration) tests.

1.0.2 (2018-04-17)

Bug Fixes

null-readme-score: add url to search (49d4065), closes #18 #19

ReadmeScore.for—and consequently, readmeInspector.getReadmeScore—returning nullScoreData, i.e., scores for READMEs that should have high marks.

Refactor readmeScoreApiClientOptions with a single property called apiEndpoint: URL in order to set the url query parameter explicitly, and call apiEndpoint.toString() for a serialized URL string.

1.0.1 (2018-04-16)

Bug Fixes

config: add default .env var values (7a71637), closes #11 #10.

Replaced dotenv with dotenv-extended in order to load default values.

1.0.0 (2018-04-12)

Features

module:readme-inspector

Verify the existence—and assess the quality—of README files
READMEs do more than explain how to use your project. They also explain why your project matters, and what your users can do with it.

In your README, try to answer the following questions:
- What does this project do?
- Why is this project useful?
- How do I get started?
- Where can I get more help, if I need it?
You can use your README to answer other questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. If you don’t want to accept contributions, or your project is not yet ready for production, write this information down. ^[1]
Public API

Methods
- authenticate - Sets GitHub credentials for all subsequent requests.
- check - Attempts to GET and assess a README at a repo-root directory.
- getReadmeInfo - Attempt to GET a README without assessing it.
- getReadmeScore - Assess the quality of a README.
Properties
- ReadmeScore - An API proxy wrapper for the readme-score-api.
- api - A configurable Octokit instance.
Documentation

Visit https://github.com/commonality/readme-inspector/#readme for more information about installation, usage, API, version, contributing guidelines, and licenses.

Commit

(e04a07a), closes #1

References

[1] Starting an Open Source Project. (2018). Open Source Guides. Retrieved 15 April 2018, from https://opensource.guide/starting-a-project/#writing-a-readme