summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2023-08-21 09:59:37 -0700
committerMatthew Miller <matthew@millerti.me>2023-08-21 09:59:37 -0700
commita7726ceefadc87d74c74efe238df85e2dde007ca (patch)
tree0eceb41a72e59a0919f09f2ad6c641f5608c843f
parentab877cc0d83b5ce0b5d4cca208e4860576c5ae43 (diff)
Update READMEs
-rw-r--r--README.md18
-rw-r--r--packages/server/README.md4
-rw-r--r--packages/typescript-types/README.md4
3 files changed, 22 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1d93d4f..ed2fe3a 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@
[![npm (scoped)](https://img.shields.io/npm/v/@simplewebauthn/server?style=for-the-badge&logo=npm)](https://www.npmjs.com/search?q=simplewebauthn)
- [Overview](#overview)
+- [Installation](#installation)
- [Example](#example)
- [Development](#development)
@@ -26,6 +27,23 @@ See these packages' READMEs for more specific implementation information.
In-depth documentation for all of the packages in this project is available here:
https://simplewebauthn.dev/docs/
+## Installation
+
+These packages are all available on **npm**:
+
+```sh
+npm install @simplewebauthn/browser
+npm install @simplewebauthn/server
+npm install @simplewebauthn/typescript-types
+```
+
+The following packages are available for import into Deno projects from **deno.land/x**:
+
+```ts
+import {...} from 'https://deno.land/x/simplewebauthn/deno/server.ts';
+import {...} from 'https://deno.land/x/simplewebauthn/deno/typescript-types.ts';
+```
+
## Example
For a practical guide to implementing these libraries, take a look at the
diff --git a/packages/server/README.md b/packages/server/README.md
index 320622b..9a7e606 100644
--- a/packages/server/README.md
+++ b/packages/server/README.md
@@ -23,10 +23,10 @@ This package is available on **npm**:
npm install @simplewebauthn/server
```
-It is also available for import into Deno projects on **deno.land/x**:
+It is also available for import into Deno projects from **deno.land/x**:
```ts
-TODO;
+import {...} from 'https://deno.land/x/simplewebauthn/deno/server.ts';
```
## Usage
diff --git a/packages/typescript-types/README.md b/packages/typescript-types/README.md
index 1b2b41f..5c8b3e6 100644
--- a/packages/typescript-types/README.md
+++ b/packages/typescript-types/README.md
@@ -15,8 +15,8 @@ This package is available on **npm**:
npm install @simplewebauthn/typescript-types
```
-It is also available for import into Deno projects on **deno.land/x**:
+It is also available for import into Deno projects from **deno.land/x**:
```ts
-TODO;
+import {...} from 'https://deno.land/x/simplewebauthn/deno/typescript-types.ts';
```