Skip to content

Commit

Permalink
Instalation part added (#49)
Browse files Browse the repository at this point in the history
* adds more specific installation instructions to README
  • Loading branch information
Iaroslav Popov authored and Zach Zibrat committed Oct 27, 2016
1 parent 46b322c commit 92ce647
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ This library currently includes the following charts:

Note: This library is still in beta, please use carefully, and file issues as discovered. Pull requests for additional charts always welcome!

## Install
First install `ember-sparkles` to your application:
```bash
ember install ember-sparkles
```
Then add default `ember-resize` configuration into `config/environment.js` file, these properties can be changed to suit your needs. For more information, please see the documentation for [ember-resize](https://github.com/mike-north/ember-resize):
```js
resizeServiceDefaults: {
widthSensitive: true,
heightSensitive: true,
debounceTimeout: 200,
injectionFactories: ['view', 'component']
},
```

## How to use

This addon includes an `{{ember-sparkles}}`, which renders a responsive SVG container element. D3-based graphs, axes, and legend components are contextually yielded from this component.
Expand Down

0 comments on commit 92ce647

Please sign in to comment.