diff options
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | example/README.md | 2 | ||||
| -rw-r--r-- | packages/browser/README.md | 2 | ||||
| -rw-r--r-- | packages/server/README.md | 2 | ||||
| -rw-r--r-- | packages/typescript-types/README.md | 2 |
5 files changed, 9 insertions, 9 deletions
@@ -14,12 +14,12 @@ This monorepo contains two complimentary libraries to help reduce the amount of work needed to incorporate WebAuthn into a website. The following packages are maintained here: -- [@simplewebauthn/server](./packages/server/) -- [@simplewebauthn/browser](./packages/browser) +- [@simplewebauthn/server](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/server) +- [@simplewebauthn/browser](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/browser) An additional package is also included that contains shared TypeScript definitions: -- [@simplewebauthn/typescript-types](./packages/typescript-types/) +- [@simplewebauthn/typescript-types](https://github.com/MasterKale/SimpleWebAuthn/tree/master/packages/typescript-types/) See these packages' READMEs for more specific implementation information. @@ -29,7 +29,7 @@ In-depth API documentation for all of the packages in this project is available ## Example -For a practical guide to implementing these libraries, take a look at the [example project](./example). It includes a single-file Express server and a few HTML files that, combined with the packages in this repo, are close to all it takes to get up and running with WebAuthn. +For a practical guide to implementing these libraries, take a look at the [example project](https://github.com/MasterKale/SimpleWebAuthn/tree/master/example). It includes a single-file Express server and a few HTML files that, combined with the packages in this repo, are close to all it takes to get up and running with WebAuthn. ## Philosophy @@ -49,7 +49,7 @@ On the surface, this is a relatively straightforward dance. Unfortunately the va **Enter SimpleWebAuthn.** -SimpleWebAuthn attempts to offer a developer-friendly pair of libraries that simplify the above dance. [@simplewebauthn/server](./packages/server/) exports a small number of methods requiring a handful of simple inputs that pair with the two primary methods exported by [@simplewebauthn/browser](./packages/browser). No converting back and forth between `Uint8Array` (or was this supposed to be an `ArrayBuffer`...?) and `String`, no worrying about JSON compatibility - **SimpleWebAuthn takes care of it all!** +SimpleWebAuthn attempts to offer a developer-friendly pair of libraries that simplify the above dance. **@simplewebauthn/server** exports a small number of methods requiring a handful of simple inputs that pair with the two primary methods exported by **@simplewebauthn/browser**. No converting back and forth between `Uint8Array` (or was this supposed to be an `ArrayBuffer`...?) and `String`, no worrying about JSON compatibility - **SimpleWebAuthn takes care of it all!** ## Tested Devices diff --git a/example/README.md b/example/README.md index 4b53d81..e62c301 100644 --- a/example/README.md +++ b/example/README.md @@ -1,6 +1,6 @@ # SimpleWebAuthn Example -A fully-functional reference implementation of [@simplewebauthn/server](../packages/server) and [@simplewebauthn/browser](../packages/browser). +A fully-functional reference implementation of **@simplewebauthn/server** and **@simplewebauthn/browser**. ## Requirements diff --git a/packages/browser/README.md b/packages/browser/README.md index 4b5a4bc..c7fb399 100644 --- a/packages/browser/README.md +++ b/packages/browser/README.md @@ -35,6 +35,6 @@ The library's methods will be available on the global `SimpleWebAuthnBrowser` ob ## Usage -Check out [the example's public/ folder](../../example/public/) for a practical implementation of this library. +Check out [the example's public/ folder](https://github.com/MasterKale/SimpleWebAuthn/tree/master/example/public/) for a practical implementation of this library. Lower-level API documentation for the methods in this library is available [here](https://docs.simplewebauthn.dev/modules/_simplewebauthn_browser.html). diff --git a/packages/server/README.md b/packages/server/README.md index 16401cb..10dd89b 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -28,7 +28,7 @@ const SimpleWebAuthnServer = require('@simplewebauthn/server'); ## Usage -Check out [the example's index.js](../../example/index.js) for a practical implementation of this library. +Check out [the example's index.js](https://github.com/MasterKale/SimpleWebAuthn/blob/master/example/index.js) for a practical implementation of this library. Lower-level API documentation for the methods in this library is available [here](https://docs.simplewebauthn.dev/modules/_simplewebauthn_server.html). diff --git a/packages/typescript-types/README.md b/packages/typescript-types/README.md index 62114b0..5190592 100644 --- a/packages/typescript-types/README.md +++ b/packages/typescript-types/README.md @@ -3,4 +3,4 @@  [](https://www.npmjs.com/package/@simplewebauthn/typescript-types) -TypeScript typings for [@simplewebauthn/server](../server/) and [@simplewebauthn/browser](../browser/) +TypeScript typings for **@simplewebauthn/server** and **@simplewebauthn/browser** |