saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added npmjs link and description getter

Browse Source
This commit is contained in:
Richard Littauer 2016-05-12 18:10:19 -04:00
parent 2d91e3c27c
commit 08115c50a5
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -36,15 +36,12 @@ There are many standards. This is mine.
## Installation ## Installation
This project uses [node][] and [npmjs][]. Go check them out if you don't have them locally installed. This project uses [node][] and [npm][]. Go check them out if you don't have them locally installed.
```sh ```sh
npm i -g standard-readme npm i -g standard-readme
``` ```
[node]: http://nodejs.org
[npmjs]: https://npmjs.com
## Usage ## Usage
Currently, this is only a Readme spec. There are plans to add [a linter](https://github.com/RichardLitt/standard-readme/issues/5) and [a generator](https://github.com/RichardLitt/standard-readme/issues/6). Currently, this is only a Readme spec. There are plans to add [a linter](https://github.com/RichardLitt/standard-readme/issues/5) and [a generator](https://github.com/RichardLitt/standard-readme/issues/6).
@ -85,7 +82,7 @@ A compliant README must:
- If present, must go beneath banner (if present), or beneath title. - If present, must go beneath banner (if present), or beneath title.
- Must be newline delimited. - Must be newline delimited.
#### one-line description #### Short Description
**Requirements:** **Requirements:**
- Must be less than 120 characters. - Must be less than 120 characters.
- Must start with `> ` - Must start with `> `
@ -95,6 +92,7 @@ A compliant README must:
**Suggestions:** **Suggestions:**
- Use [gh-description](https://github.com/RichardLitt/gh-description) to set and get GitHub description. - Use [gh-description](https://github.com/RichardLitt/gh-description) to set and get GitHub description.
- Use `npm show . description` to show the description from a local [npm][] package.
#### Table of Contents #### Table of Contents
Requirements: There must be a Table of Contents that links to the Requirements: There must be a Table of Contents that links to the
@ -128,3 +126,6 @@ etc.
## License ## License
MIT (c) Protocol Labs MIT (c) Protocol Labs
[node]: http://nodejs.org
[npmjs]: https://npmjs.com