├── LICENSE
├── README.md
└── rules.md


/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Stephan Schneider
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | **DRAFT STAGE**
 2 | 
 3 | *Please [contribute in the issues](https://github.com/zcei/standard-readme/issues) to this evolving standard, as it makes no sense to define rules no one sticks to.*
 4 | 
 5 | 
 6 | standard-readme
 7 | ===============
 8 | 
 9 | > Describes how a README should look like, according to `standard-readme`
10 | 
11 | ![Travis Build Badge](https://img.shields.io/travis/joyent/node/v0.6.svg)
12 | [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
13 | 
14 | ## Install
15 | 
16 | ```js
17 | npm install standard-readme
18 | ```
19 | 
20 | ## Usage
21 | ```
22 | $ readme README.md
23 | ```
24 | 
25 | ```js
26 | var readme = require('standard-readme');
27 | 
28 | // Checks readme in current working directory
29 | readme.check('.')
30 | ```
31 | 
32 | ## API
33 | 
34 | We need some more input for this.
35 | Consider sharing your opinion in [this issue](https://github.com/zcei/standard-readme/issues/3).
36 | 
37 | ## Contributing
38 | 
39 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/zcei/standard-readme/issues/new).
40 | But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.
41 | 


--------------------------------------------------------------------------------
/rules.md:
--------------------------------------------------------------------------------
 1 | # Rules
 2 | 
 3 | In the following a README is defined in its structure.
 4 | 
 5 | 
 6 | It consists of blocks, which is a (sub)section, often started by a heading.
 7 | 
 8 | A block can be nested into another block, and has one or more rules validating its integrity.
 9 | 
10 | The position of a child block is defined by its parent.
11 | 
12 | 
13 | ## Blocks
14 | 
15 | ### Heading
16 | * requires a *title*
17 | * (optional) Block: `Badges`
18 | * followed by *description*
19 | 
20 | ### Install(ation)
21 | * Even if it's just `npm install <my-package>`, because sometimes it's not
22 | * Sytem dependencies (like `ffmpeg`) are mentioned here
23 | 
24 | ### Usage / Example
25 | * A minimal example
26 | * Should use / show most default values
27 | * Shows how the developers intend the usage
28 | * If CLI, use the most common flags in your call
29 | 
30 | ### API
31 | * [Discussion in #3](https://github.com/zcei/standard-readme/issues/3)
32 | 
33 | ### License
34 | * Is strictly mandatory (until further reviewed by lawyer/responsible persons - [Discussion](https://github.com/zcei/standard-readme/issues/4))
35 | * (optional) link to `LICENSE` file (required, if `LICENSE` file is available in repo)
36 | 
37 | 
38 | ## Optional Blocks
39 | 
40 | ### Badges
41 | * http://shields.io/
42 | * No constraints regarding flat, rounded, etc..
43 | * Can also include images / gifs showing the projects' behavior
44 | 
45 | ### Command Line
46 | 
47 | * Structure of `--help` output
48 | * Can be more verbose
49 | 
50 | ### Contributing
51 | 
52 | * See default text in `standard-readme`s readme
53 | * (optional) Link to `CONTRIBUTING.md`
54 | * Should be the very last block before `License`
55 | 
56 | ### `Custom Block`
57 | 
58 | * Everything not defined in this standard will just be linted to ensure proper markdown formatting (thanks to awesome [`remark-lint`](https://github.com/wooorm/remark-lint/))
59 | * Should come after required blocks, but before `License` block
60 | 


--------------------------------------------------------------------------------