Remove print out option, update Usage

This closed https://github.com/RichardLitt/standard-readme/issues/32
This commit is contained in:
Richard Littauer 2016-09-05 15:48:30 -04:00
parent 7f6d06fad1
commit 13ed550828
3 changed files with 3 additions and 15 deletions

View File

@ -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. 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 ```sh
$ npm i -g standard-readme $ npm i standard-readme
``` ```
## Usage ## Usage
Currently, this is only a README spec. Currently, this is mainly a documentation package. You will get the most benefit by reading [spec.md](spec.md).
```
$ standard-readme
// Will print spec.md to the console
```
### Generator ### 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 ### Badge

View File

@ -1,6 +0,0 @@
var fs = require('graceful-fs')
var doc = 'spec.md'
fs.readFile(doc, { encoding: 'utf8' }, function(err, data) {
console.log(data)
})

View File

@ -28,7 +28,6 @@
}, },
"homepage": "https://github.com/RichardLitt/standard-readme", "homepage": "https://github.com/RichardLitt/standard-readme",
"dependencies": { "dependencies": {
"graceful-fs": "^4.1.2"
}, },
"coordinates": [ "coordinates": [
42.3957744, 42.3957744,