Comparing version 1.1.2 to 1.1.3
{ | ||
"name": "bounty", | ||
"version": "1.1.2", | ||
"version": "1.1.3", | ||
"description": "SVG odometer effect", | ||
@@ -5,0 +5,0 @@ "main": "lib/bounty.js", |
@@ -14,7 +14,8 @@ SVG Odometer Effect Library | ||
Examples | ||
====== | ||
## Examples | ||
The API is really simple and straigthforward: | ||
```js | ||
bounty.default({ el: '.js-bounty', value: '£42,000,000' }); | ||
import bounty from `bounty`; | ||
bounty({ el: '.js-bounty', value: '£42,000,000' }); | ||
``` | ||
@@ -38,2 +39,4 @@ | ||
```js | ||
import bounty from `bounty`; | ||
const cancel = bounty({ el: '.js-bounty', value: '£42,000,000' }); | ||
@@ -43,16 +46,13 @@ cancel(); | ||
Library is built using umd thus the following usage is possible. | ||
Library is built using **UMD** thus the following usage in **HTML** is possible. | ||
```html | ||
<body> | ||
<div class="js-bounty"></div> | ||
<script src="/bounty.js"></script> | ||
<script> | ||
bounty.default({ el: '.js-bounty', value: '£42,000,000' }) | ||
</script> | ||
</body> | ||
<div class="js-bounty"></div> | ||
<script src="/bounty.js"></script> | ||
<script> | ||
bounty.default({ el: '.js-bounty', value: '£42,000,000' }) | ||
</script> | ||
``` | ||
That's it? | ||
===== | ||
## That's it? | ||
Yea! That's it. Other options like `font-family` and `font-size` are taken from **computed styles** so you can just style it like the other layers. | ||
@@ -68,4 +68,3 @@ ```css | ||
Roadmap | ||
==== | ||
## Roadmap | ||
There is a work in progress to implement additional features: | ||
@@ -72,0 +71,0 @@ * `from` `to` API. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
11282
75