From 4616f0f1f33780441d46140f5d252c44d5e5fc63 Mon Sep 17 00:00:00 2001 From: Andrew Patton Date: Tue, 17 Dec 2024 17:56:17 -0800 Subject: [PATCH] README: remove defunct/abandoned links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit • the vella.ai/auth link is 404ing • the raohwork/webauthn-client repo says WIP Project but hasn’t been updated in 5 ½ years --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0cf3a99..aa61a22 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,6 @@ ---- -Check out [vella.ai/auth](https://vella.ai/auth/) for a demo app using this library for local-only authentication with WebAuthn and local encryption. - [Library Tests (Demo)](https://mylofi.github.io/webauthn-local-client/) ---- @@ -17,7 +15,7 @@ The `WebAuthn` API lets users of web applications avoid the long-troubled use of However, the intended use-case for **WebAuthn-Local-Client** is to allow [Local-First Web](https://localfirstweb.dev/) applications to handle user login locally on a device, without any server (FIDO2 or otherwise). -**Note:** This package *may* be used in combination with a traditional FIDO2 server application architecture, but does not include any specific functionality for that purpose. For server integration with `WebAuthn`, you may instead consider alternative libraries, like [this one](https://github.com/passwordless-id/webauthn) or [this one](https://github.com/raohwork/webauthn-client). +**Note:** This package *may* be used in combination with a traditional FIDO2 server application architecture, but does not include any specific functionality for that purpose. For server integration with `WebAuthn`, you may instead consider alternative libraries, like [this one](https://github.com/passwordless-id/webauthn). ## Deployment / Import @@ -196,7 +194,7 @@ See `authDefaults()` function signature for more options. `auth()` returns a promise that's fulfilled (success or rejection) once the user completes or cancels a credential (aka "passkey") authentication with their device's authenticator. -If `auth()` completes completes successfully, the return value (`authResult` above) will be an object that includes `request` and `response` properties: +If `auth()` completes successfully, the return value (`authResult` above) will be an object that includes `request` and `response` properties: * The `request` property includes all relevant configurations that were applied to the authentication request, and is provided mostly for debugging purposes.