Short blurb about what your product does.
One to two paragraph statement about your product and what it does.
OS X & Linux:
npm install my-crazy-module --save
Windows:
edit autoexec.bat
A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
For more examples and usage, please refer to the Wiki.
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
docker-compose build
docker-compose up
- 0.2.1
- CHANGE: Update docs (module code remains unchanged)
- 0.0.1
- Work in progress
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/
License This is available as open source under the terms of the MIT License.