mikejavier
1/15/2016 - 1:07 PM

Readme Boilerplate

Readme Boilerplate

README Boilerplate

A template of README best practices to make your README simple to understand and easy to use.

Installation

Download to your project directory, add README.md, and commit:

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

Feel free to remove any sections that aren't applicable to your project.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.