summaryrefslogtreecommitdiffhomepage
path: root/packages/browser/README.md
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2020-05-29 15:25:10 -0700
committerMatthew Miller <matthew@millerti.me>2020-05-29 15:25:10 -0700
commit7157b97e4737ced23a9b3aed794e10ba01708dcf (patch)
tree90a2592db80925be0051afab484e1738c72b8f3c /packages/browser/README.md
parent94da8b7e7750c6c61526975aad302d5ac4e2d063 (diff)
Update server and browser README with docs links
Diffstat (limited to 'packages/browser/README.md')
-rw-r--r--packages/browser/README.md9
1 files changed, 5 insertions, 4 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).