Skip to content

added @see for the README documentation #42

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

added @see for the README documentation #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36819b6
added @see for the README documentation
johalloran01 Jul 4, 2023
e2a1db1
Editing for `Devise::Passkeys::PasskeyAuthenticatable` README references
tcannonfodder Jul 7, 2023
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
6 changes: 6 additions & 0 deletions lib/devise/passkeys/model.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,15 @@ module Models
# This is the actual module that gets included in your
# model when you include `:passkey_authenticatable` in the
# `devise` call (eg: `devise :passkey_authenticatable, ...`).
#
# Please consult the {file:README.md#label-Usage} for model installation
# & configuration instructions.
module PasskeyAuthenticatable
# This is a callback that is called right after a successful passkey authentication.
#
# **Important**: You **must** follow the steps in the {file:README.md#label-Usage} to fully set up a model
# and use passkeys.
#
# By default, it is a no-op, but you can override it in your model for any custom behavior
# (such as notifying the user of a new login).
# @param passkey [String] the passkey that was used for authentication
Expand Down