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

Added links to desc

Browse Source
This commit is contained in:
Richard Littauer 2016-07-27 11:55:02 -04:00
parent 2cc9b5d607
commit 45b4ca9985
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -11,11 +11,11 @@ Your README file is normally the first entry point to your code. It should tell
This repository contains: This repository contains:
1. The specification for how a standard README should look. 1. [The specification](spec.md) for how a standard README should look.
2. A link to a linter you can use to keep your README maintained. 2. A link to a linter you can use to keep your README maintained ([work in progress](https://github.com/RichardLitt/standard-readme/issues/5)).
3. A link to a generator you can use to create standard READMEs. 3. A link to [a generator](https://github.com/RichardLitt/generator-standard-readme) you can use to create standard READMEs.
4. A badge to point to this spec. 4. [A badge](#badge) to point to this spec.
5. Examples of standard READMEs - such as this one. 5. [Examples of standard READMEs](example-readmes/) - such as this file you are reading.
## Table of Contents ## Table of Contents