https://github.com/richardlitt/standard-readme-cli

A CLI for standard readme
https://github.com/richardlitt/standard-readme-cli

cli hint hinter lint linter readme standard standard-readme

Last synced: 29 days ago
JSON representation

A CLI for standard readme

• Host: GitHub
• URL: https://github.com/richardlitt/standard-readme-cli
• Owner: RichardLitt
• License: mit
• Created: 2017-05-05T13:38:06.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-02-12T17:38:04.000Z (almost 3 years ago)
• Last Synced: 2024-12-26T11:23:02.124Z (about 1 month ago)
• Topics: cli, hint, hinter, lint, linter, readme, standard, standard-readme
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# standard-readme-cli

> A CLI tool for linting READMEs according to standard-readme

This is a **Work in Progress**. See [#4](https://github.com/RichardLitt/standard-readme-cli/issues/4).

## Install

```sh

$ npm i -g standard-readme

```

Note: This package has overridden the old [standard-readme](https://github.com/RichardLitt/standard-readme), which is now used only for the spec and has been renamed on npm to `standard-readme-spec`.

## Usage

In a folder with a 'README.md' file:

```sh

$ standard-readme

[]

/Users/richard/src/standard-readme-cli/README.md: no issues found

```

## Maintainers

- [@RichardLitt](https://github.com/RichardLitt)

## Contributing

Please do! Open an issue, or file a PR.

## License

[MIT](LICENSE) © 2017 Richard Littauer