From 4d880bb0faa49512d9acb90a9d112c0a846c6c5b Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 12 May 2016 17:58:32 -0400 Subject: [PATCH] More reqs --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 850c9d8..03353f1 100644 --- a/README.md +++ b/README.md @@ -93,11 +93,19 @@ A compliant README must: #### Badges **Requirements:** -- If present, must start on third line. +- If present, must go beneath banner (if present), or beneath title. - Must be newline delimited. #### 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 Requirements: There must be a Table of Contents that links to the