0.7.0 • Published 7 years ago
jm-addon v0.7.0
materia-jm-addon
Demo
https://GeoAstronaute.github.io/jm-addon/
Table of contents
About
addon tes
Installation
Install through npm:
npm install --save jm-addon
Then include in your apps module:
import { NgModule } from '@angular/core';
import { JmAddonModule } from 'jm-addon';
@NgModule({
imports: [
JmAddonModule.forRoot()
]
})
export class MyModule {}
Finally use in one of your apps components:
import { Component } from '@angular/core';
@Component({
template: '<hello-world></hello-world>'
})
export class MyComponent {}
You may also find it useful to view the demo source.
Usage without a module bundler
<script src="node_modules/jm-addon/bundles/jm-addon.umd.js"></script>
<script>
// everything is exported jmAddon namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://GeoAstronaute.github.io/jm-addon/docs/
Development
Prepare your environment
Development server
Run yarn start
to start a development server on port 8000 with auto reload + tests.
Testing
Run yarn test
to run tests once or yarn run test:watch
to continually run tests.
Release
- Bump the version in package.json (once the module hits 1.0 this will become automatic)
yarn run release
License
MIT