From e0155d7467bd1233390741ce30735f5d96a9d596 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 3 Jun 2016 11:02:31 +0100 Subject: [PATCH] Added badge code example --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 84d48e7..b33161d 100644 --- a/README.md +++ b/README.md @@ -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