Short blurb about what your product does.
[![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Downloads Stats][npm-downloads]][npm-url]
One to two paragraph statement about your product and what it does.
To get the project up and running on your computer, you must have Java installed. Run the project in your IDE of choice. The below instructions are only necessary if you need to use the features of Maven, such as dependencies, executable JARs, and testing.
-
Clone the repository
-
Enter the following command in the project root directory:
mvn install
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][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.
make install
npm test
- 0.2.1
- CHANGE: Update docs (module code remains unchanged)
- 0.2.0
- CHANGE: Remove
setDefaultXYZ()
- ADD: Add
init()
- CHANGE: Remove
- 0.1.1
- FIX: Crash when calling
baz()
(Thanks @GenerousContributorName!)
- FIX: Crash when calling
- 0.1.0
- The first proper release
- CHANGE: Rename
foo()
tobar()
- 0.0.1
- Work in progress
- John Tur