diff options
| author | akanass <akanass@icloud.com> | 2021-04-15 19:24:46 +0200 |
|---|---|---|
| committer | akanass <akanass@icloud.com> | 2021-04-15 19:24:46 +0200 |
| commit | d9fd21a1d9f787fdd1b271f0bb89ddf9f6f30ff5 (patch) | |
| tree | 60c9308a9bd5ea8a366861585f8b2dd8aa8ed380 | |
| parent | 8a4489a0994862478699e9f24d1f429a6bddb8a6 (diff) | |
fix documentation
| -rw-r--r-- | packages/browser/README.md | 62 |
1 files changed, 24 insertions, 38 deletions
diff --git a/packages/browser/README.md b/packages/browser/README.md index c5695e4..1d080cd 100644 --- a/packages/browser/README.md +++ b/packages/browser/README.md @@ -7,16 +7,16 @@  - [@simplewebauthn/browser](#simplewebauthnbrowser) - - [Installation](#installation) - - [UMD](#umd) - - [ES5](#es5) - - [ES2018](#es2018) - - [Usage](#usage) - - [Building for Production](#building-for-production) - - [ES5](#es5-1) - - [ES2018](#es2018-1) - - [Webpack support](#webpack-support) - - [Rollup support](#rollup-support) + - [Installation](#installation) + - [UMD](#umd) + - [ES5](#es5) + - [ES2018](#es2018) + - [Usage](#usage) + - [Building for Production](#building-for-production) + - [ES5](#es5-1) + - [ES2018](#es2018-1) + - [Webpack support](#webpack-support) + - [Rollup support](#rollup-support) ## Installation @@ -28,19 +28,17 @@ 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. #### 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/es5/index.umd.min.js'></script> +<script src="https://unpkg.com/@simplewebauthn/browser/dist/es5/index.umd.min.js"></script> ``` #### ES2018 @@ -49,7 +47,7 @@ If you only need to support modern browsers, include the `ES2018` version: ```html -<script src='https://unpkg.com/@simplewebauthn/browser/dist/es2018/index.umd.min.js'></script> +<script src="https://unpkg.com/@simplewebauthn/browser/dist/es2018/index.umd.min.js"></script> ``` ## Usage @@ -58,23 +56,18 @@ You can find in-depth documentation on this package here: https://simplewebauthn ## Building for Production -Two unbundled versions of this library are offered for your convenience, one targeting `ES2018` and a second -targeting `ES5`. +Two unbundled versions of this library are offered for your convenience, one targeting `ES2018` and a second targeting `ES5`. ### ES5 -The `ES5` version is suitable for use when **old browsers** need to be supported and it's **default** version of this -library which is read in the `main` entry from @simplewebauthn/browser's **package.json**. +The `ES5` version is suitable for use when **old browsers** need to be supported and it's **default** version of this library which is read in the `main` entry from @simplewebauthn/browser's **package.json**. -TypeScript and JavaScript codebases alike can import and use this library without any special build configuration -considerations. +TypeScript and JavaScript codebases alike can import and use this library without any special build configuration considerations. However, you will need to ensure that the `tslib` dependency gets pulled into your build artifact: -- If you are authoring your application in TypeScript then this package will be **automatically** included so long as - your **tsconfig.json** sets `"target": "ES5"`. -- If your application is written in Javascript then you will need to install this package **manually** by adding it - to `dependencies` in your project's **package. json**: +- If you are authoring your application in TypeScript then this package will be **automatically** included so long as your **tsconfig.json** sets `"target": "ES5"`. +- If your application is written in Javascript then you will need to install this package **manually** by adding it to `dependencies` in your project's **package. json**: ```sh $> npm install tslib @@ -82,15 +75,11 @@ $> npm install tslib ### ES2018 -The `ES2018` version is suitable for use when only **modern browsers** need to be supported. TypeScript and JavaScript -codebases alike can import and use this library. However, you will need to ensure that your bundler pulls in the ES2018 -version of the library when building your application! +The `ES2018` version is suitable for use when only **modern browsers** need to be supported. TypeScript and JavaScript codebases alike can import and use this library. However, you will need to ensure that your bundler pulls in the ES2018 version of the library when building your application! #### Webpack support -No matter the `"target"` of your build, though, then you'll need to indicate additional files for WebPack to resolve via -the [`"resolve.mainFields"`](https://webpack.js.org/configuration/resolve/#resolvemainfields) property in your Webpack -config to read in the `jsnext:main` entry from @simplewebauthn/browser's **package.json**: +No matter the `"target"` of your build, though, then you'll need to indicate additional files for WebPack to resolve via the [`"resolve.mainFields"`](https://webpack.js.org/configuration/resolve/#resolvemainfields) property in your Webpack config to read in the `jsnext:main` entry from @simplewebauthn/browser's **package.json**: ```js module.exports = { @@ -101,13 +90,11 @@ module.exports = { }; ``` -`'jsnext:main'` must come first in the list to ensure that the `ES2018` version of this library is bundled. Additional -values can be added afterwards as needed. +`'jsnext:main'` must come first in the list to ensure that the `ES2018` version of this library is bundled. Additional values can be added afterwards as needed. #### Rollup support -The [`@rollup/plugin-node-resolve`](https://github.com/rollup/rollup-plugin-node-resolve#usage) plugin has to be added -to your Rollup config to read in the `jsnext:main` entry from @simplewebauthn/browser's **package.json**: +The [`@rollup/plugin-node-resolve`](https://github.com/rollup/rollup-plugin-node-resolve#usage) plugin has to be added to your Rollup config to read in the `jsnext:main` entry from @simplewebauthn/browser's **package.json**: ```js // rollup.config.js @@ -123,5 +110,4 @@ export default { } ``` -`'jsnext:main'` must come first in the list to ensure that the `ES2018` version of this library is bundled. Additional -values can be added afterwards as needed. +`'jsnext:main'` must come first in the list to ensure that the `ES2018` version of this library is bundled. Additional values can be added afterwards as needed. |