Skip to content

README template

Canonical template for the README format.

# Project Name
[badges: build status, version, license, downloads]
> One-sentence description of what the project does.
A short paragraph (2 to 4 sentences) explaining what problem this solves and who it is for.
## Install

[single install command, e.g. npm install foo or pip install foo]

## Quick start
```[language]
[minimal working example, ideally under 10 lines]

See CONTRIBUTING.md.

[License name] - see LICENSE.