Skip to content

Instantly share code, notes, and snippets.

@marcobeltempo

marcobeltempo/README.md

Created December 8, 2017 04:58
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 marcobeltempo/428fa542cbe6e4d30a32ebc9b28fa866 to your computer and use it in GitHub Desktop.
Save marcobeltempo/428fa542cbe6e4d30a32ebc9b28fa866 to your computer and use it in GitHub Desktop.
Download ZIP
README.md Template
Raw
README.md

GitHub Logo

Project Title

Brief overview of your project

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

List the minimum requirements and tools needed to run your program

Installing

Setup instructions

Usage

Include a variety of examples using snippets, images etc.

Testing

Explain how to run the automated tests for this system

npm Scripts

This command will build and execute the program

npm start

Known Issues

Acknowledge known issues and provide a workaround

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

License name

Social

Instructions how to access your projcts community

Web Icon GitHub Icon Twitter Icon LinkedIn Icon Email Icon

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