README TEMPLATE

What to include in your README to stand out against other repositories and marketing yourself to gain traction for open source projects.

Project Name

• Write a project description
  • What problem does it solve?
  • What platform does it use? Mobile? Web? Both?
  • Is it a gem/application/kata?

Stack

• List all the programming languages/frameworks/etc.

Software Architecture/Site Map

• Create a visualization that best represents how your repository functions

Installation

• Describe the installation process
  • What dependencies are required to run the repository smoothly?

Usage

• Write usage instructions
  • How does one use this?
  • Include photos to advertise. GitHub is an app store for open source projects!

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Features and Requirements

• Task 1
• Task 2
• Task 3

History

• Write history

Credits

• Write credits

License

• Write license

Great READMEs:

• Free Code Camp
• Open Farm
• D3
• Charter