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

Added badge code example

Browse Source
This commit is contained in:
Richard Littauer 2016-06-03 11:02:31 +01:00
parent 2056df4e0f
commit e0155d7467
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -19,6 +19,7 @@ This repo is for standardizing how READMEs should look. The goal is to have:
- [Goals:](#goals)
- [Installation](#installation)
- [Usage](#usage)
- [Badge](#badge)
- [Specification](#specification)
- [Requirements](#requirements)
- [Sections](#sections)
@ -79,11 +80,15 @@ $ standard-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:
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**.
[![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**.
To add in Markdown format, use this code:
```
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
```
### Example Readmes