Skip to content

Commit

Permalink
docs: Updated Readme with breaking changes
Browse files Browse the repository at this point in the history
  • Loading branch information
robertsLando committed Nov 25, 2019
1 parent ff32c9a commit 76043c1
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ JustGage is a handy JavaScript plugin for generating and animating nice & cl
- [Pointer options](#pointer-options)
- [Methods](#methods)
- [Refresh](#refresh)
- [Update](#update)
- [Update Options](#update-options)
- [Destroy](#destroy)
- [Demo](#demo)
- [Examples](#examples)
- [Changelog](#changelog)
- [BREAKING CHANGES](#breaking-changes)
- [License](#license)
- [Author](#author)

Expand Down Expand Up @@ -206,14 +209,13 @@ const options = {
gauge.update(options)
```

#### Options
#### Update Options

| Name | Description |
| -------------------- | ------------------------------------------- |
| valueFontColor | HEX color for gauge value text |
| labelFontColor | HEX color for gauge min, max and label text |


### Destroy

Used to destroy the Gauge element
Expand All @@ -234,6 +236,13 @@ Check out the auto-generated [Changelog](CHANGELOG.md)

Or [here](CHANGELOG_OLD.md) you can find the old changelog (up to version 1.2.9)

### BREAKING CHANGES

- 1.2.9
- `customSectors` expects an object and not an array (percent support, check docs for more info)
- 1.2.6
- Removed `title` feature

## License

This project is licensed under [MIT](LICENSE) License
Expand Down

0 comments on commit 76043c1

Please sign in to comment.