README
Trunk Module Name
Short description
Installation
Make sure all dependencies have been installed before moving on:
npm install --save @cherrypulp/trunk-module-name
Quick start
Configuration and setup
// config/trunk-module-name.js
export default {
mySetting: false, // explanation of that setting
};
// main.js
import { TrunkModuleServiceProvider } from '@cherrypulp/trunk-module-name';
...
app.register(new TrunkModuleServiceProvider(app));
...
Documentation
Something
Explanation about what something does.
app.Something('foo');
Versioning
Versioned using SemVer.
Contribution
Please raise an issue if you find any. Pull requests are welcome!
Author
- Stéphan Zych - monkey_monk
License
This project is licensed under the MIT License - see the LICENSE file for details.
TODO
- do it