summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--packages/browser/README.md9
-rw-r--r--packages/server/README.md10
2 files changed, 11 insertions, 8 deletions
diff --git a/packages/browser/README.md b/packages/browser/README.md
index 2135527..f3aa868 100644
--- a/packages/browser/README.md
+++ b/packages/browser/README.md
@@ -1,5 +1,4 @@
<!-- omit in toc -->
-
# @simplewebauthn/browser
![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
@@ -8,7 +7,7 @@
- [Installation](#installation)
- [UMD](#umd)
-- [Usage - Coming Soon](#usage---coming-soon)
+- [Usage](#usage)
## Installation
@@ -34,6 +33,8 @@ This package can also be installed via **unpkg** by including the following scri
The library's methods will be available on the global `SimpleWebAuthnBrowser` object.
-## Usage - Coming Soon
+## Usage
+
+Check out [the example's public/ folder](../../example/public/) for a practical implementation of this library.
-Check out [the example](../../example/public/) for now until this section gets updated.
+Lower-level API documentation for the methods in this library is available [here](https://simplewebauthn.netlify.app/modules/_simplewebauthn_browser.html).
diff --git a/packages/server/README.md b/packages/server/README.md
index a56b022..cee2de7 100644
--- a/packages/server/README.md
+++ b/packages/server/README.md
@@ -1,5 +1,4 @@
<!-- omit in toc -->
-
# @simplewebauthn/server
![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
@@ -7,7 +6,7 @@
![node-lts (scoped)](https://img.shields.io/node/v/@simplewebauthn/server?style=for-the-badge&logo=Node.js)
- [Installation](#installation)
-- [Usage - Coming Soon](#usage---coming-soon)
+- [Usage](#usage)
- [Supported Attestation Formats](#supported-attestation-formats)
## Installation
@@ -27,9 +26,12 @@ import SimpleWebAuthnServer from '@simplewebauthn/server';
const SimpleWebAuthnServer = require('@simplewebauthn/server');
```
-## Usage - Coming Soon
+## Usage
+
+Check out [the example's index.js](../../example/index.js) for a practical implementation of this library.
+
+Lower-level API documentation for the methods in this library is available [here](https://simplewebauthn.netlify.app/modules/_simplewebauthn_server.html).
-Check out [the example](../../example/index.js) for now until this section gets updated.
## Supported Attestation Formats