diff --git a/README.md b/README.md new file mode 100644 index 0000000..93c6ef4 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +[![Build Status](https://travis-ci.org/codyjdalton/ts-module-seed.svg?branch=master)](https://travis-ci.org/codyjdalton/ts-module-seed) [![Coverage Status](https://coveralls.io/repos/github/codyjdalton/ts-module-seed/badge.svg?branch=master)](https://coveralls.io/github/codyjdalton/ts-module-seed?branch=master) + +# Typescript Module Seed + +One Paragraph of project description goes here + +## 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. + +### Installing + +A step by step series of examples that tell you have to get a development env running + +Say what the step will be + +``` +npm i project-name --save +``` + +End with an example of getting some data out of the system or using it for a little demo + +## Running the tests + +Explain how to run the automated tests for this system + +``` +npm test +``` + +## Deployment + +Add additional notes about how to deploy this on a live system + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details \ No newline at end of file