v2.0.5

2.0.5 (2018-04-27)

Dependency Updates

• codacy-coverage: update to v3.0.0 (7a2a515)

v2.0.4

2.0.4 (2018-04-26)

Dependency Updates

• lint-staged: update to v7.0.5 (#28) (941a070)

v2.0.3

2.0.3 (2018-04-25)

Dependency Updates

• meow: update to v5.0.0 (572aee9), closes #26

v2.0.2

2.0.2 (2018-04-25)

Dependency updates

• eslint-plugin-standard: update to v3.1.0 (d7fa19e)

v2.0.1

2.0.1 (2018-04-24)

Bug Fixes

• config: move .env files to project root (4c893ac), closes #23

v2.0.0

2.0.0 (2018-04-21)

Bug Fixes

• api: add integration tests (96546fe), closes #18 #21

BREAKING CHANGES

• api: two method signatures and one property name have changed.

Objects & Properties

1. readmeInspector.ReadmeScore - refactor:rename ReadmeScore ➡️ ReadmeAppraisal
2. module:readme-inspector/readme-score - refactor:rename 'ReadmeScore'
   module:readme-inspector/readme-appraisal 'ReadmeAppraisal', which is now
   a class.

Functions

1. getReadmeInfo
   1.1. Function name - refactor:rename ➡️ getInfo
   1.2. Function signature - now expects a params object literal

2. getReadmeScore
   2.1. Function name - refactor:rename ➡️ getAppraisal
   2.2. Function signature remains the same as in 1.x.x.

3. check's signature now expects a params object literal,
   which it passes to getInfo.

API tests

Add API (integration) tests to verify appraisal initialization.

1. Create the lib/apis/ directory
2. Add Jest/Jasmine specs without mocks
3. Invoke real APIs for results

CI

1. Create four ENV variables on Appveyor.
2. Customize greenkeeper commit messages

Documentation

• Use commonality branding colors for 'Request a Feature' and
  'Report a Defect' badges
• Move DEVELOPERS.md user the /docs/project/ directory
• Add secure variables to for API testing
• Iterate through filepaths with markdown files that require
  automated content generation

v1.0.3

1.0.3 (2018-04-21)

Dependency updates

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

v1.0.2

1.0.2 (2018-04-17)

Bug Fixes

• readme-score: ensure scoreData are returned (70d3965), closes #18 #18 #19 #18 #19 #18 #18 #19 #18 #19 #18 #19 #18 #19 #18 #19 #18 #19 #18 #19 #18 #19

v1.0.1

1.0.1 (2018-04-16)

Bug Fixes

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

v1.0.0

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.

  "Starting An Open Source Project." Open Source Guides.
  N. p., 2018. Web. 12 Apr. 2018.

  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

  • readme: detect and score on GitHub (Enterprise) (e3583e0), closes #1