From 13ed5508288771bf149253e4032f6158aae3f4be Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 5 Sep 2016 15:48:30 -0400 Subject: [PATCH] Remove print out option, update Usage This closed https://github.com/RichardLitt/standard-readme/issues/32 --- README.md | 11 +++-------- index.js | 6 ------ package.json | 1 - 3 files changed, 3 insertions(+), 15 deletions(-) delete mode 100644 index.js diff --git a/README.md b/README.md index a428c20..269f939 100644 --- a/README.md +++ b/README.md @@ -60,21 +60,16 @@ The goals for this repository are: This project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed. ```sh -$ npm i -g standard-readme +$ npm i standard-readme ``` ## Usage -Currently, this is only a README spec. - -``` -$ standard-readme -// Will print spec.md to the console -``` +Currently, this is mainly a documentation package. You will get the most benefit by reading [spec.md](spec.md). ### Generator -To use the generator, look at [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme). +To use the generator, look at [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme). There is a global executable to run the generator in that package, aliased as `standard-readme`. ### Badge diff --git a/index.js b/index.js deleted file mode 100644 index 0ffe762..0000000 --- a/index.js +++ /dev/null @@ -1,6 +0,0 @@ -var fs = require('graceful-fs') -var doc = 'spec.md' - -fs.readFile(doc, { encoding: 'utf8' }, function(err, data) { - console.log(data) -}) diff --git a/package.json b/package.json index dc9d31c..d89589b 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,6 @@ }, "homepage": "https://github.com/RichardLitt/standard-readme", "dependencies": { - "graceful-fs": "^4.1.2" }, "coordinates": [ 42.3957744,