Skip to content

Commit

Permalink
Update browser and server READMs
Browse files Browse the repository at this point in the history
  • Loading branch information
MasterKale committed Nov 23, 2024
1 parent f778661 commit 8c6e4e5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
27 changes: 25 additions & 2 deletions packages/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@

- [@simplewebauthn/browser](#simplewebauthnbrowser)
- [Installation](#installation)
- [Deno v1.43.x or higher](#deno-v143x-or-higher)
- [UMD](#umd)
- [ES5](#es5)
- [ES2018](#es2018)
- [ES2021](#es2021)
- [Usage](#usage)

## Installation
Expand All @@ -21,6 +22,28 @@ This package is available on **npm**:
npm install @simplewebauthn/browser
```

This package can be installed from **NPM** or **JSR**:

```sh
$ npm install @simplewebauthn/browser
```

```sh
$ npx jsr add @simplewebauthn/browser
```

### Deno v1.43.x or higher

It is also available for import into Deno projects from **deno.land/x** or **JSR**:

```ts
import {...} from 'https://deno.land/x/simplewebauthn/deno/browser.ts';
```

```sh
$ deno add jsr:@simplewebauthn/browser jsr:@simplewebauthn/types
```

### UMD

This package can also be installed via **unpkg** by including the following script in your page's
Expand All @@ -40,7 +63,7 @@ include the `ES5` version:
<script src="https://unpkg.com/@simplewebauthn/browser/dist/bundle/index.es5.umd.min.js"></script>
```

#### ES2018
#### ES2021

If you only need to support modern browsers, include the `ES2018` version:

Expand Down
2 changes: 1 addition & 1 deletion packages/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ $ npm install @simplewebauthn/server
```

```sh
$ npx jsr add @simplewebauthn/server @simplewebauthn/types
$ npx jsr add @simplewebauthn/server
```

### Deno v1.43.x or higher
Expand Down

0 comments on commit 8c6e4e5

Please sign in to comment.