diff --git a/README.md b/README.md index cb94779..61d6ab1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,79 @@ +# JustGage + +![Justgage](docs/img/logo.png) + +[![Downloads](https://img.shields.io/npm/dm/justgage.svg)](https://www.npmjs.com/package/justgage) + +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) +[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://opensource.org/licenses/mit-license.php) + +[![NPM](https://nodei.co/npm/justgage.png?downloads=true)](https://nodei.co/npm/justgage/) + JustGage is a handy JavaScript plugin for generating and animating nice & clean dashboard gauges. It is based on Raphaƫl library for vector drawing. -### Changelog +## Getting Started + +Installing Justgage is as easy as... + +```bash +bower install justgage-official +``` + +or maybe you wish to use NPM... + +```bash +npm install justgage +``` + +or you can always download the CSS and JS files... + +```html + + + +``` + +or if even don't want to download the files use [cdnjs](https://cdnjs.com/libraries/justgage) + +```html + + + +``` + +## Basic usage + +**Html** + +```html +
+``` + +**JS** + +```js + +var gauge = new JustGage({ + id: "gauge", // the id of the html element + value: 50, + min: 0, + max: 100, + decimals: 2, + gaugeWidthScale: 0.6 + }); + +// update the value randomly +setInterval(() => { + gauge.refresh(Math.random() * 100); +}, 5000) + +``` + +## Demo + +Click [here](https://justgage.com/) to see a demo + +## Changelog ###### September 26, 2016. - release 1.2.9 * **customSectors** receives structural update + additional "percents" feature (define ranges in %). diff --git a/docs/img/logo.png b/docs/img/logo.png new file mode 100644 index 0000000..7b416f2 Binary files /dev/null and b/docs/img/logo.png differ