A template to start a README with, stolen liberally from https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

template-README.md

Project Title

project description

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

Just Node.JS; I generally use the LTS which is 8.10.0 at time of writing.

Installing

Clone the repo and install dependencies

git clone https://github.com/rick-roche/project-name
cd project-name
npm i

Running the tests

Two types of tests are included; unit tests (testing the internals) and end to end tests (testing the exposed interfaces)

Unit tests

Explain what these tests test and why

Give an example

End to end tests

Explain what these tests test and why

Give an example

Linting

The repo makes use of tslint and you can lint your code by running

npm run lint

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Node.JS - The runtime environment
• Typescript - JavaScript that scales

Contributing

Please submit a pull request and get in touch! I use semantic commits so please do the same.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Rick Roché - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc