standard-readme/example-readmes/maximal-readme.md

69 lines
1.2 KiB
Markdown
Raw Normal View History

2016-05-23 11:48:02 +00:00
# Title
![banner]()
![badge]()
![badge]()
[![license](https://img.shields.io/github/license/:user/:repo.svg)](LICENSE)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
2016-05-23 11:48:02 +00:00
This is an example file with maximal choices selected.
2016-05-23 11:48:02 +00:00
This is a long description.
## Table of Contents
- [Security](#security)
- [Background](#background)
- [Install](#install)
2016-05-23 11:48:02 +00:00
- [Usage](#usage)
- [API](#api)
- [Contributing](#contributing)
2016-05-23 11:48:02 +00:00
- [License](#license)
## Security
### Any optional sections
## Background
### Any optional sections
## Install
This module depends upon a knowledge of [Markdown]().
```
```
### Any optional sections
## Usage
```
```
Note: The `license` badge image link at the top of this file should be updated with the correct `:user` and `:repo`.
2016-05-23 11:48:02 +00:00
### Any optional sections
## API
### Any optional sections
## More optional sections
## Contributing
2016-05-23 11:48:02 +00:00
See [the contributing file](CONTRIBUTING.md)!
2016-05-23 11:48:02 +00:00
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)