diff options
| author | Matthew Miller <matthew@millerti.me> | 2020-05-23 15:53:36 -0700 |
|---|---|---|
| committer | Matthew Miller <matthew@millerti.me> | 2020-05-23 15:53:36 -0700 |
| commit | 6fdbc36cdcd44bcd68767ca7c804a4ce55520c1a (patch) | |
| tree | bb5269212ecdb9f935c644daf28a7363e0d392de | |
| parent | 3283a52ed99aa6f2d90cde9cb59f2ee9d7a2b4c9 (diff) | |
Add installation instructions for packages
| -rw-r--r-- | packages/browser/README.md | 26 | ||||
| -rw-r--r-- | packages/server/README.md | 20 |
2 files changed, 46 insertions, 0 deletions
diff --git a/packages/browser/README.md b/packages/browser/README.md index 2c402c7..03bbf2a 100644 --- a/packages/browser/README.md +++ b/packages/browser/README.md @@ -2,3 +2,29 @@  [](https://www.npmjs.com/package/@webauthntine/browser)  + +## Installation + +### npm + +This package is available on **npm**: + +```sh +npm install @webauthntine/browser +``` + +It can then be imported into a project as usual: + +```js +import WebAuthntineBrowser from '@webauthntine/browser'; +``` + +### UMD + +This package can also be installed via **unpkg** by including the following script in your page's `<head>` element: + +```html +<script src="https://unpkg.com/@webauthntine/browser/dist/webauthntine-browser.min.js"></script> +``` + +The library's methods will be available on the global `WebAuthntineBrowser` object. diff --git a/packages/server/README.md b/packages/server/README.md index fe5402f..ead9803 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -2,3 +2,23 @@  [](https://www.npmjs.com/package/@webauthntine/server)  + +## Installation + +### npm + +This package is available on **npm**: + +```sh +npm install @webauthntine/server +``` + +It can then be imported into a Node project as usual: + +```js +// ESModule +import WebAuthntineServer from '@webauthntine/server'; +// CommonJS +const WebAuthntineServer = require('@webauthntine/server'); + +``` |