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

Bold, small edit

Browse Source
This commit is contained in:
Richard Littauer 2016-05-13 12:32:26 -04:00
parent d083918784
commit f2fe325f7e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -12,7 +12,7 @@ This repo is for standardizing how READMEs should look. The goal is to have:
- A linter that can be used to look at errors in a given Readme; - 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. - A generator that can be used to quickly scaffold out new READMEs.
## Table of Contents** ## Table of Contents
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
@ -44,8 +44,8 @@ Standard Readme started with in the issue originally posed by [@maxogden](https:
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.
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. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/6).
5. A compliant badge. 5. A **compliant badge** for users.
## Installation ## Installation