diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3a0976c --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# README Boilerplate + +A template of README best practices to make your README simple to understand and easy to use. + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Support](#support) +- [Contributing](#contributing) + +## Installation + +Download to your project directory, add `README.md`, and commit: + +```sh +curl -LO http://git.io/Xy0Chg +git add README.md +git commit -m "Use README Boilerplate" +``` + +## Usage + +Replace the contents of `README.md` with your project's: + +- Name +- Description +- Installation instructions +- Usage instructions +- Support instructions +- Contributing instructions +- Licence + +Feel free to remove any sections that aren't applicable to your project. + +## Support + +Please [open an issue](https://github.com/fraction/readme-boilerplate/issues/new) for support. + +## Contributing + +Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/fraction/readme-boilerplate/compare/).
\ No newline at end of file |