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

Updated usage section and contribute

Browse Source
This commit is contained in:
Richard Littauer 2016-05-12 18:07:20 -04:00
parent 6d2ccf5994
commit 2d91e3c27c
1 changed files with 2 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -36,8 +36,6 @@ There are many standards. This is mine.
## Installation ## Installation
_Note: This is a placeholder, at the moment._
This project uses [node][] and [npmjs][]. Go check them out if you don't have them locally installed. This project uses [node][] and [npmjs][]. Go check them out if you don't have them locally installed.
```sh ```sh
@ -49,20 +47,11 @@ npm i -g standard-readme
## Usage ## Usage
_Note: This is a placeholder, at the moment._ 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).
The settings are stored in the `.remarkrc` file. Ideally, this file should be added to each repository where
you plan to use `remark`. There are plans to enable a single `.remarkrc` to be used in multiple repos.
```sh
$ npm i -g remark
$ npm i
$ remark README.md -o README.md
```
## Contribute ## Contribute
Feel free to dive in! Open an issue or submit PRs. Feel free to dive in! [Open an issue](https://github.com/RichardLitt/standard-readme/issues/new) or submit PRs.
## Specification ## Specification