Skip to content

Update README.md with installation instructions #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update README.md with installation instructions #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,20 @@ Here's a simple example of an animation that fades and scales a `<div>`.
</script>
```

Install
-----------

Install the [npm](https://www.npmjs.com/package/web-animations-js) package:

`npm install web-animations-js`

then use web-animation-js as either a CommonJS or an ES2015 module:

CommonJS module: `require('web-animation-js')`
or ES2015 module: `import 'web-animation-js'`

This will requires a module bundler such as [Browserify](http://browserify.org/), [Webpack](https://webpack.js.org), or [Rollup](https://rollupjs.org/).

Documentation
-------------

Expand Down