Skip to content

Instantly share code, notes, and snippets.

@timofei7
Created November 15, 2016 04:47
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save timofei7/873e07aad88b966eb9bcbba01d6a1a4b to your computer and use it in GitHub Desktop.
Save timofei7/873e07aad88b966eb9bcbba01d6a1a4b to your computer and use it in GitHub Desktop.
README.md example

Project Name

TODO:

  • short project description
  • some sample screenshots or mockups

Architecture

TODO: descriptions of code organization and tools and libraries used

Setup

TODO: how to get the project dev environment up and running, npm install etc

Deployment

TODO: how to deploy the project

Authors

TODO: list of authors (with dates)

Acknowledgments

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