Skip to content

Commit 78de3ee

Browse files
Merge pull request #498 from cedarcode/sr--improve-readme
Mention passkeys in the `README` and gem description
2 parents e9f9d70 + 0d62bae commit 78de3ee

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _More_: [SECURITY](SECURITY.md)
3838

3939
### What is WebAuthn?
4040

41-
WebAuthn (Web Authentication) is a W3C standard for secure public-key authentication on the Web supported by all leading browsers and platforms.
41+
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.
4242

4343
#### Good Intros
4444

@@ -86,7 +86,7 @@ Or install it yourself as:
8686

8787
## Usage
8888

89-
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).
89+
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).
9090

9191
If you are migrating an existing application from the legacy FIDO U2F JavaScript API to WebAuthn, also refer to
9292
[`docs/u2f_migration.md`](docs/u2f_migration.md).

‎webauthn.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
1212

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

0 commit comments

Comments
 (0)