diff options
| author | Matthew Miller <matthew@millerti.me> | 2023-08-22 08:53:41 -0700 |
|---|---|---|
| committer | Matthew Miller <matthew@millerti.me> | 2023-08-22 08:53:41 -0700 |
| commit | 031437e9f7860947d277b0cec61ac975dfdbf018 (patch) | |
| tree | 9be6f4d666bd7294b28e87653682439eeb325c9a | |
| parent | ab7cdeb6d9d0a2b56f76f9c45fb18379b22695b4 (diff) | |
Tweak README's
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | packages/server/README.md | 17 | ||||
| -rw-r--r-- | packages/typescript-types/README.md | 6 |
3 files changed, 16 insertions, 11 deletions
@@ -29,8 +29,8 @@ https://simplewebauthn.dev/docs/ ## Installation -These packages are all available on **npm** for use in **Node LTS 16.x** projects (and supports -**both CommonJS and ESM**): +These packages are all available on **npm** for use in **Node LTS 16.x** projects and supports +**both CommonJS and [ECMAScript modules (ESM)](https://nodejs.org/api/esm.html#enabling)**: ```sh npm install @simplewebauthn/browser diff --git a/packages/server/README.md b/packages/server/README.md index 3758a57..29fab31 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -3,26 +3,25 @@  [](https://www.npmjs.com/package/@simplewebauthn/server) -- [Requirements](#requirements) - [Installation](#installation) + - [Node LTS 16.x or higher](#node-lts-16x-or-higher) + - [Deno v1.33.x or higher](#deno-v133x-or-higher) - [Usage](#usage) - [Supported Attestation Formats](#supported-attestation-formats) -## Requirements - -Both of the following runtimes are officially supported: - -- Node LTS 16.x -- Deno v1.33.x - ## Installation -This package is available on **npm** and supports **both CommonJS and ESM** projects: +### Node LTS 16.x or higher + +This package is available on **npm** and supports **both CommonJS and +[ECMAScript modules (ESM)](https://nodejs.org/api/esm.html#enabling)** projects: ```sh npm install @simplewebauthn/server ``` +### Deno v1.33.x or higher + It is also available for import into Deno projects from **deno.land/x**: ```ts diff --git a/packages/typescript-types/README.md b/packages/typescript-types/README.md index 5c8b3e6..2220d02 100644 --- a/packages/typescript-types/README.md +++ b/packages/typescript-types/README.md @@ -6,15 +6,21 @@ TypeScript typings for **@simplewebauthn/server** and **@simplewebauthn/browser** - [Installation](#installation) + - [Node LTS 16.x or higher](#node-lts-16x-or-higher) + - [Deno v1.33.x or higher](#deno-v133x-or-higher) ## Installation +### Node LTS 16.x or higher + This package is available on **npm**: ```sh npm install @simplewebauthn/typescript-types ``` +### Deno v1.33.x or higher + It is also available for import into Deno projects from **deno.land/x**: ```ts |