A template of README best practices to make your README simple to understand and easy to use.
Download to your project directory and commit:
curl -LO http://git.io/Xy0Chg
git add PATH
git commit -m "Use README Boilerplate"
/app
/docs
/src
/client
/collections
/compatability
/conf
/lib
/routers
/startup
/stylesheets
/subscriptions
/views
/collections
/lib
/private
/public
/images
/server
/publication
/startup
Replace the contents of PATH
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.
Please open an issue for support.
Please contribute using Github Flow. Create a branch, add commits, and open a pull request.