You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* replace gulp build with rollup
* bump version
* point main to es6 module
* revert change to test umd
* remove browserify
* update eslint config
* fix rollup error
* update readme
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,8 @@ Or tinker with CountUp in [Stackblitz](https://stackblitz.com/edit/countup-types
21
21
-**Highly customizeable** with a large range of options, you can even substitute numerals.
22
22
-**Smart easing**: CountUp intelligently defers easing until it gets close enough to the end value for easing to be visually noticeable. Configureable in the [options](#options).
23
23
-**Plugins** allow for alternate animations like the [Odometer plugin](https://www.npmjs.com/package/odometer_countup)
-**Separate bundles** for modern and legacy browsers, with and without the requestAnimationFrame polyfill. Choose `countUp.min.js` for modern browsers or `countUp.withPolyfill.min.js` for IE9 and older, and Opera mini.
26
26
27
27
## Usage:
28
28
@@ -143,7 +143,7 @@ countUp.handleScroll();
143
143
144
144
Currently there's just one plugin, the **[Odometer Plugin](https://github.com/msoler75/odometer_countup.js)**.
145
145
146
-
To use a plugin, use the plugin option:
146
+
To use a plugin, you'll need to first install the plugin package. Then you can include it and use the plugin option. See each plugin's docs for more detailed info.
@@ -156,7 +156,7 @@ If you'd like to make your own plugin, see [the docs](#creating-animation-plugin
156
156
157
157
## Including CountUp
158
158
159
-
CountUp is distributed as an ES6 module because it is the most standardized and most widely compatible module for browsers, though a UMD module is [also included](#umd-module).
159
+
CountUp is distributed as an ES6 module because it is the most standardized and most widely compatible module for browsers, though a UMD module is [also included](#umd-module), along with a separate requestAnimationFrame polyfill (see below).
160
160
161
161
For the examples below, first install CountUp. This will give you the latest:
162
162
```
@@ -206,6 +206,10 @@ var numAnim = new countUp.CountUp('myTarget', 2000);
206
206
numAnim.start()
207
207
```
208
208
209
+
### requestAnimationFrame polyfill
210
+
211
+
You can include `dist/requestAnimationFrame.polyfill.js` if you want to support IE9 and older, and Opera mini.
0 commit comments