Merge pull request #12 from Vagab/documentation/passkeys-model

Add top level & method documentation into Devise::Passkeys::Model

CHANGELOG.md

@@ -4,6 +4,8 @@
   - https://github.com/ruby-passkeys/devise-passkeys/pull/7/
 - Bump `Devise` requirement to `>= 4.7.1`
   - https://github.com/ruby-passkeys/devise-passkeys/pull/11
+- Document `Devise::Passkeys::Model`
+  - https://github.com/ruby-passkeys/devise-passkeys/pull/12
 
 ## [0.1.0] - 2023-05-07
 

THANKS.md

@@ -5,3 +5,4 @@
 - [@heliocola](https://github.com/heliocola)
 - [@johalloran01](https://github.com/johalloran01)
 - [@tcannonfodder](https://github.com/tcannonfodder)
+- [@Vagab](https://github.com/Vagab)

lib/devise/passkeys/model.rb

@@ -2,7 +2,13 @@
 
 module Devise
   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, ...`).
     module PasskeyAuthenticatable
+      # This is a callback that is called right after a successful passkey authentication.
+      #
+      # By default, it is a no-op, but you can override it in your model for any custom behavior (such as notifying users of a new login).
       def after_passkey_authentication; end
     end
   end