diff options
author | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:46:06 -0300 |
---|---|---|
committer | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:48:30 -0300 |
commit | 38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch) | |
tree | 453dbf70000cc5e338b06201af1eaca8343f8f73 /history/docs/Installation.md | |
parent | f26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff) | |
download | node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2 node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip |
Diffstat (limited to 'history/docs/Installation.md')
-rw-r--r-- | history/docs/Installation.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/history/docs/Installation.md b/history/docs/Installation.md new file mode 100644 index 0000000..5f55fb2 --- /dev/null +++ b/history/docs/Installation.md @@ -0,0 +1,25 @@ +# Installation + +The history library is published to the public [npm](https://www.npmjs.com/) registry. You can install it using: + + $ npm install --save history + +Then, use as you would anything else: + +```js +// using ES6 modules +import { createBrowserHistory } from 'history'; + +// using CommonJS modules +var createBrowserHistory = require('history').createBrowserHistory; +``` + +## Using Globals + +If you really just want a `<script>` tag, the UMD build is available on [unpkg](https://unpkg.com): + +```html +<script src="https://unpkg.com/history"></script> +``` + +You can find the library on `window.History`. |