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

More reqs

Browse Source
This commit is contained in:
Richard Littauer 2016-05-12 17:58:32 -04:00
parent cad48f6543
commit 4d880bb0fa
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -93,11 +93,19 @@ A compliant README must:
#### Badges #### Badges
**Requirements:** **Requirements:**
- If present, must start on third line. - If present, must go beneath banner (if present), or beneath title.
- Must be newline delimited. - Must be newline delimited.
#### one-line description #### one-line description
Requirements: 120 char or less. **Requirements:**
- Must be less than 120 characters.
- Must start with `> `
- Must be on it's own line.
- Must match the description in the packager manager's `description` field.
- Must match GitHub's description (if on GitHub).
**Suggestions:**
- Use [gh-description](https://github.com/RichardLitt/gh-description) to set and get GitHub description.
#### Table of Contents #### Table of Contents
Requirements: There must be a Table of Contents that links to the Requirements: There must be a Table of Contents that links to the