Skip to content

v1.0.0
Compare
Choose a tag to compare
@gregswindle gregswindle released this 12 Apr 20:36
· 24 commits to master since this release
v1.0.0
e3583e0
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

1.0.0 (2018-04-12)

Features

  • module:readme-inspector: Verify the existence—and assess the quality—of README files

    quote 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
Assets 2
Loading