README.md from synapsemx/ember-smoother-signature

README.md
Summary

Maintainability

Test Coverage

Issues
ember-smoother-signature

[![Ember Observer Score](https://emberobserver.com/badges/ember-smoother-signature.svg)](https://emberobserver.com/addons/ember-smoother-signature) [![npm version](https://badge.fury.io/js/ember-smoother-signature.svg)](https://badge.fury.io/js/ember-smoother-signature) [![Code Climate](https://codeclimate.com/github/synapsemx/ember-smoother-signature/badges/gpa.svg)](https://codeclimate.com/github/synapsemx/ember-smoother-signature) [![Issue Count](https://codeclimate.com/github/synapsemx/ember-smoother-signature/badges/issue_count.svg)](https://codeclimate.com/github/synapsemx/ember-smoother-signature)

This addon is a wrapper for the _**excellent**_ [signature_pad](https://github.com/szimek/signature_pad) library.


### Works great on a desktop...
![Desktop](http://i.imgur.com/Ss41wRX.png)

### ...or on a mobile device!
![Mobile](http://i.imgur.com/MrWFxXs.png)


Installation
------------------------------------------------------------------------------

Install this addon using ember-cli:
```
ember install ember-smoother-signature
```

Usage
------------------------------------------------------------------------------

Use ember-smoother-signature in your template:
```
{{signature-pad
    submit=(action 'YOUR_ACTION')
    back=(action 'YOUR_ACTION')
}}
```

>DISCLAIMER: If you look at signature_pad, it has many more options.
>
>We'll incorporate all that soon, but if you have time on your hands then feel free to submit a PR!

Contributing
------------------------------------------------------------------------------

### Installation

* `git clone` this repository
* `cd ember-smoother-signature`
* `npm install`

### Linting

* `npm run lint:js`
* `npm run lint:js -- --fix`

### Running tests

* `ember test` – Runs the test suite on the current Ember version
* `ember test --server` – Runs the test suite in "watch mode"
* `ember try:each` – Runs the test suite against multiple Ember versions

### Running the dummy application

* `ember serve`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).


License
------------------------------------------------------------------------------

This project is licensed under the [MIT License](LICENSE.md).
[embadge]: http://embadge.io/