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

Added Badge

Browse Source 
Related to #18
This commit is contained in:
Richard Littauer 2016-06-03 10:53:14 +01:00
parent 7b450b3fa1
commit e1f5760875
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -3,6 +3,7 @@
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
> Readme Standard Style > Readme Standard Style
@ -69,13 +70,21 @@ $ npm i -g standard-readme
## Usage ## Usage
Currently, this is only a Readme spec. Currently, this is only a Readme spec.
``` ```
$ standard-readme $ standard-readme
// Will output spec (this Readme) // Will output spec (this Readme)
``` ```
### Badge
If your README is compliant with Standard-Readme and you're on GitHub, it would be great if you could add the badge:
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
This allows people to link back to this Spec, and helps adoption of the README. The badge is **not required**.
### Example Readmes ### Example Readmes
To see how the specification has been applied, see the [example-readmes](example-readmes/). To see how the specification has been applied, see the [example-readmes](example-readmes/).