Skip to content

Instantly share code, notes, and snippets.

@defo550
Created September 6, 2013 18:59
Show Gist options
  • Save defo550/6468375 to your computer and use it in GitHub Desktop.
Save defo550/6468375 to your computer and use it in GitHub Desktop.
README.md template

Description

Describe the project, what is it. What problem does the application look to solve.

Code Samples

Show how other people can use your project (i.e. API, library, framework).

code sample

Installation

How do you start this thing?! Explain how to get the application running or to integrate it.

Contributors

Description on how other can contribute to the project. Provide links bug report,issue trackers, twitter feeds... List who has contributed to the project or main contributors.

License

Copyright and licensing information (i.e. MIT, Apache, etc.).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment