From 08115c50a5b91b5c0ceca33742b5d13fb7ceee24 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 12 May 2016 18:10:19 -0400 Subject: [PATCH] Added npmjs link and description getter --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 81344a9..c1fa502 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,12 @@ There are many standards. This is mine. ## Installation -This project uses [node][] and [npmjs][]. Go check them out if you don't have them locally installed. +This project uses [node][] and [npm][]. Go check them out if you don't have them locally installed. ```sh npm i -g standard-readme ``` -[node]: http://nodejs.org -[npmjs]: https://npmjs.com - ## Usage Currently, this is only a Readme spec. There are plans to add [a linter](https://github.com/RichardLitt/standard-readme/issues/5) and [a generator](https://github.com/RichardLitt/standard-readme/issues/6). @@ -85,16 +82,17 @@ A compliant README must: - If present, must go beneath banner (if present), or beneath title. - Must be newline delimited. -#### one-line description +#### Short Description **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 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. +- Use `npm show . description` to show the description from a local [npm][] package. #### Table of Contents Requirements: There must be a Table of Contents that links to the @@ -128,3 +126,6 @@ etc. ## License MIT (c) Protocol Labs + +[node]: http://nodejs.org +[npmjs]: https://npmjs.com \ No newline at end of file