diff --git a/README.md b/README.md index a6d8889..a52a40e 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,10 @@ $ standard-readme // Will output spec (this Readme) ``` +### Example Readmes + +To see how the specification has been applied, see the [example-readmes](example-readmes/). + ## Specification ### Requirements diff --git a/example-readmes/maximal-readme.md b/example-readmes/maximal-readme.md new file mode 100644 index 0000000..5c7f2ea --- /dev/null +++ b/example-readmes/maximal-readme.md @@ -0,0 +1,64 @@ +# Title + +![banner]() + +![badge]() +![badge]() + +> This is an example file with maximal choices selected. + +This is a long description. + +## Table of Contents + +- [Security](#security) +- [Background](#background) +- [Installation](#installation) +- [Usage](#usage) +- [API](#api) +- [Contribute](#contribute) +- [License](#license) + +## Security + +### Any optional sections + +## Background + +### Any optional sections + +## Install + +This module depends upon a knowledge of [Markdown](). + +``` +``` + +### Any optional sections + +## Usage + +``` +``` + +### Any optional sections + +## API + +### Any optional sections + +## More optional sections + +## Contribute + +See [the contribute file](contribute.md)! + +PRs accepted. + +Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. + +### Any optional sections + +## License + +[MIT © Richard McRichface.](../LICENSE) diff --git a/example-readmes/minimal-readme.md b/example-readmes/minimal-readme.md new file mode 100644 index 0000000..a9b23a2 --- /dev/null +++ b/example-readmes/minimal-readme.md @@ -0,0 +1,28 @@ +# Title + +> This is an example file with default selections. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Contribute](#contribute) +- [License](#license) + +## Install + +``` +``` + +## Usage + +``` +``` + +## Contribute + +PRs accepted. + +## License + +MIT © Richard McRichface