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

Added generator note, removed doubled goals

Browse Source 
Related to #6
This commit is contained in:
Richard Littauer 2016-06-18 14:08:54 +01:00
parent c571eabff4
commit c87e8545d6
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,11 +7,7 @@
> Readme Standard Style > Readme Standard Style
This repo is for standardizing how READMEs should look. The goal is to have: This repo is for standardizing how READMEs should look. The goal is to have a spec, a linter, a generator, a badge, and examples.
- A well defined specification that other people could look to;
- An example README that can be used for comparison (this README.md is the example);
- A linter that can be used to look at errors in a given Readme;
- A generator that can be used to quickly scaffold out new READMEs.
## Table of Contents ## Table of Contents
@ -56,10 +52,10 @@ change the module's internals as long as the interface remains the same.
### Goals: ### Goals:
1. A well defined **specification**. This can be found in the [Specification](#specification) section. It is a constant work in progress; please open issues to discuss changes. 1. A well defined **specification**. This can be found in the [Specification](#specification) section. It is a constant work in progress; please open issues to discuss changes.
2. **An example README**. This Readme is fully standard-readme compliant. 2. **An example README**. This Readme is fully standard-readme compliant, and there are more examples in the `example-readmes` folder.
3. A **linter** that can be used to look at errors in a given Readme. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/5). 3. A **linter** that can be used to look at errors in a given Readme. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/5).
4. A **generator** that can be used to quickly scaffold out new READMEs. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/6). 4. A **generator** that can be used to quickly scaffold out new READMEs. See [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme).
5. A **compliant badge** for users. 5. A **compliant badge** for users. See [the badge](#badge).
## Installation ## Installation
@ -78,6 +74,10 @@ $ standard-readme
// Will output spec (this Readme) // Will output spec (this Readme)
``` ```
### Generator
To use the generator, look at [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme).
### Badge ### Badge
If your README is compliant with Standard-Readme and you're on GitHub, it would be great if you could add the badge. This allows people to link back to this Spec, and helps adoption of the README. The badge is **not required**. If your README is compliant with Standard-Readme and you're on GitHub, it would be great if you could add the badge. This allows people to link back to this Spec, and helps adoption of the README. The badge is **not required**.