summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--packages/browser/README.md11
-rw-r--r--packages/server/README.md10
2 files changed, 17 insertions, 4 deletions
diff --git a/packages/browser/README.md b/packages/browser/README.md
index 03bbf2a..8af1f66 100644
--- a/packages/browser/README.md
+++ b/packages/browser/README.md
@@ -1,11 +1,14 @@
+<!-- omit in toc -->
# @webauthntine/browser
![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
[![npm (scoped)](https://img.shields.io/npm/v/@webauthntine/browser?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@webauthntine/browser)
![Browser Support](https://img.shields.io/badge/Browser-ES2018+-brightgreen?style=for-the-badge&logo=Mozilla+Firefox)
-## Installation
+- [Installation](#installation)
+ - [UMD](#umd)
+- [Usage - Coming Soon](#usage---coming-soon)
-### npm
+## Installation
This package is available on **npm**:
@@ -28,3 +31,7 @@ This package can also be installed via **unpkg** by including the following scri
```
The library's methods will be available on the global `WebAuthntineBrowser` object.
+
+## Usage - Coming Soon
+
+Check out [src/index.ts](./src/index.ts) for now until this section gets updated.
diff --git a/packages/server/README.md b/packages/server/README.md
index ead9803..429ad24 100644
--- a/packages/server/README.md
+++ b/packages/server/README.md
@@ -1,11 +1,13 @@
+<!-- omit in toc -->
# @webauthntine/server
![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
[![npm (scoped)](https://img.shields.io/npm/v/@webauthntine/server?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@webauthntine/server)
![node-lts (scoped)](https://img.shields.io/node/v/@webauthntine/server?style=for-the-badge&logo=Node.js)
-## Installation
+- [Installation](#installation)
+- [Usage - Coming Soon](#usage---coming-soon)
-### npm
+## Installation
This package is available on **npm**:
@@ -22,3 +24,7 @@ import WebAuthntineServer from '@webauthntine/server';
const WebAuthntineServer = require('@webauthntine/server');
```
+
+## Usage - Coming Soon
+
+Check out [src/index.ts](./src/index.ts) for now until this section gets updated.