Skip to content

Mention passkeys in the README and gem description #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
santiagorodriguez96 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mention passkeys in the README and gem description #498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ _More_: [SECURITY](SECURITY.md)

### What is WebAuthn?

WebAuthn (Web Authentication) is a W3C standard for secure public-key authentication on the Web supported by all leading browsers and platforms.
WebAuthn (Web Authentication) is a W3C standard for secure public-key authentication on the Web supported by all leading browsers and platforms. WebAuthn is the standard that underpins passkeys, the phishing-resistant replacement for passwords.

#### Good Intros

Expand Down Expand Up @@ -86,7 +86,7 @@ Or install it yourself as:

## Usage

You can find a working example on how to use this gem in a pasword-less login in a __Rails__ app in [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app). If you want to see an example on how to use this gem as a second factor authenticator in a __Rails__ application instead, you can check it in [webauthn-2fa-rails-demo](https://github.com/cedarcode/webauthn-2fa-rails-demo).
You can find a working example on how to use this gem in a passwordless login (e.g. a passkey-based passwordless and usernameless login) in a __Rails__ app in [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app). If you want to see an example on how to use this gem as a second factor authenticator in a __Rails__ application instead, you can check it in [webauthn-2fa-rails-demo](https://github.com/cedarcode/webauthn-2fa-rails-demo).

If you are migrating an existing application from the legacy FIDO U2F JavaScript API to WebAuthn, also refer to
[`docs/u2f_migration.md`](docs/u2f_migration.md).
Expand Down
2 changes: 1 addition & 1 deletion webauthn.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Gem::Specification.new do |spec|

spec.summary = "WebAuthn ruby server library"
spec.description = 'WebAuthn ruby server library ― Make your application a W3C Web Authentication conformant
Relying Party and allow your users to authenticate with U2F and FIDO2 authenticators.'
Relying Party and allow your users to authenticate with FIDO2/U2F authenticators as passkeys or security keys.'
spec.homepage = "https://github.com/cedarcode/webauthn-ruby"
spec.license = "MIT"

Expand Down
Loading