diff --git a/lib/devise/passkeys/model.rb b/lib/devise/passkeys/model.rb index 4666925..222b5dd 100644 --- a/lib/devise/passkeys/model.rb +++ b/lib/devise/passkeys/model.rb @@ -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