Skip to content

Commit

Permalink
Added generator note, removed doubled goals
Browse files Browse the repository at this point in the history
Related to #6
  • Loading branch information
RichardLitt committed Jun 18, 2016
1 parent c571eab commit c87e854
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@

> Readme Standard Style
This repo is for standardizing how READMEs should look. The goal is to have:
- A well defined specification that other people could look to;
- An example README that can be used for comparison (this README.md is the example);
- A linter that can be used to look at errors in a given Readme;
- A generator that can be used to quickly scaffold out new READMEs.
This repo is for standardizing how READMEs should look. The goal is to have a spec, a linter, a generator, a badge, and examples.

## Table of Contents

Expand Down Expand Up @@ -56,10 +52,10 @@ change the module's internals as long as the interface remains the same.

### Goals:
1. A well defined **specification**. This can be found in the [Specification](#specification) section. It is a constant work in progress; please open issues to discuss changes.
2. **An example README**. This Readme is fully standard-readme compliant.
2. **An example README**. This Readme is fully standard-readme compliant, and there are more examples in the `example-readmes` folder.
3. A **linter** that can be used to look at errors in a given Readme. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/5).
4. A **generator** that can be used to quickly scaffold out new READMEs. Please refer to the [tracking issue](https://github.com/RichardLitt/standard-readme/issues/6).
5. A **compliant badge** for users.
4. A **generator** that can be used to quickly scaffold out new READMEs. See [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme).
5. A **compliant badge** for users. See [the badge](#badge).

## Installation

Expand All @@ -78,6 +74,10 @@ $ standard-readme
// Will output spec (this Readme)
```

### Generator

To use the generator, look at [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme).

### Badge

If your README is compliant with Standard-Readme and you're on GitHub, it would be great if you could add the badge. This allows people to link back to this Spec, and helps adoption of the README. The badge is **not required**.
Expand Down

0 comments on commit c87e854

Please sign in to comment.