Skip to content

Commit f8b6043

Browse files
author
Max Heiber
authored
Update README.md with installation instructions
Add installation instructions. The README didn't reference npm even though there is an npm package: web-animations#134 had a TODO for adding the installation instructions to the README. Are these installation instructions right? Or is it `require('web-animation-js').polyfill()` instead of just `require('web-animation-js')`? Thank you for your work on this library and the cool demos.
1 parent a035866 commit f8b6043

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,20 @@ Here's a simple example of an animation that fades and scales a `<div>`.
4141
</script>
4242
```
4343

44+
Install
45+
-----------
46+
47+
Install the [npm](https://www.npmjs.com/package/web-animations-js) package:
48+
49+
`npm install web-animations-js`
50+
51+
then use web-animation-js as either a CommonJS or an ES2015 module:
52+
53+
CommonJS module: `require('web-animation-js')`
54+
or ES2015 module: `import 'web-animation-js'`
55+
56+
This will requires a module bundler such as [Browserify](http://browserify.org/), [Webpack](https://webpack.js.org), or [Rollup](https://rollupjs.org/).
57+
4458
Documentation
4559
-------------
4660

0 commit comments

Comments
 (0)