Installation instructions missing in the readme

web-animations / web-animations-js

JavaScript implementation of the Web Animations API

http://web-animations.github.io

Apache License 2.0

3.77k stars 408 forks source link

Installation instructions missing in the readme #198

Open slikts opened 6 years ago

slikts commented 6 years ago

The readme doesn't mention an npm package or give a CDN link; it just says to include <script src="web-animations.min.js"></script>, so I guess it means downloading the file from releases, which is a generally poor approach of managing dependencies. I had to look it up to find: https://www.npmjs.com/package/web-animations-js

arxpoetica commented 5 years ago

Agree. I'm scratching my head trying to figure out how to dynamically import the library, for example, using my own feature sniffing techniques.

Martin-Pitt commented 5 years ago

If the readme does not mention it, it might be an unofficial reupload to the npm registry. So who knows who actually maintains that and if they don't turn out to hijack your users.

NodeGuy commented 4 years ago

The instructions are hidden here: https://github.com/web-animations/web-animations-js/blob/dev/docs/support.md#getting-the-polyfill