Added npmjs link and description getter
This commit is contained in:
parent
2d91e3c27c
commit
08115c50a5
11
README.md
11
README.md
@ -36,15 +36,12 @@ There are many standards. This is mine.
|
||||
|
||||
## 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
|
||||
npm i -g standard-readme
|
||||
```
|
||||
|
||||
[node]: http://nodejs.org
|
||||
[npmjs]: https://npmjs.com
|
||||
|
||||
## 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).
|
||||
@ -85,7 +82,7 @@ A compliant README must:
|
||||
- If present, must go beneath banner (if present), or beneath title.
|
||||
- Must be newline delimited.
|
||||
|
||||
#### one-line description
|
||||
#### Short Description
|
||||
**Requirements:**
|
||||
- Must be less than 120 characters.
|
||||
- Must start with `> `
|
||||
@ -95,6 +92,7 @@ A compliant README must:
|
||||
|
||||
**Suggestions:**
|
||||
- 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
|
||||
Requirements: There must be a Table of Contents that links to the
|
||||
@ -128,3 +126,6 @@ etc.
|
||||
## License
|
||||
|
||||
MIT (c) Protocol Labs
|
||||
|
||||
[node]: http://nodejs.org
|
||||
[npmjs]: https://npmjs.com
|
Loading…
Reference in New Issue
Block a user