diff options
Diffstat (limited to 'packages/browser/README.md')
| -rw-r--r-- | packages/browser/README.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/packages/browser/README.md b/packages/browser/README.md index d94700b..7ef312e 100644 --- a/packages/browser/README.md +++ b/packages/browser/README.md @@ -23,16 +23,20 @@ npm install @simplewebauthn/browser ### UMD -This package can also be installed via **unpkg** by including the following script in your page's `<head>` element. The library's methods will be available on the global **`SimpleWebAuthnBrowser`** object. +This package can also be installed via **unpkg** by including the following script in your page's +`<head>` element. The library's methods will be available on the global **`SimpleWebAuthnBrowser`** +object. -> NOTE: The only difference between the two packages below is that the ES5 bundle includes TypeScript's `tslib` runtime code. This adds some bundle size overhead, but _does_ enable use of `supportsWebAuthn()` in older browsers to show appropriate UI when WebAuthn is unavailable. +> NOTE: The only difference between the two packages below is that the ES5 bundle includes +> TypeScript's `tslib` runtime code. This adds some bundle size overhead, but _does_ enable use of +> `supportsWebAuthn()` in older browsers to show appropriate UI when WebAuthn is unavailable. #### ES5 -If you need to support WebAuthn feature detection in deprecated browsers like IE11 and Edge Legacy, include the `ES5` version: +If you need to support WebAuthn feature detection in deprecated browsers like IE11 and Edge Legacy, +include the `ES5` version: ```html - <script src="https://unpkg.com/@simplewebauthn/browser/dist/bundle/index.es5.umd.min.js"></script> ``` @@ -41,10 +45,10 @@ If you need to support WebAuthn feature detection in deprecated browsers like IE If you only need to support modern browsers, include the `ES2018` version: ```html - <script src="https://unpkg.com/@simplewebauthn/browser"></script> ``` ## Usage -You can find in-depth documentation on this package here: https://simplewebauthn.dev/docs/packages/browser +You can find in-depth documentation on this package here: +https://simplewebauthn.dev/docs/packages/browser |