ruby-passkeys / devise-passkeys

Devise extension to use passkeys instead of passwords
MIT License
172 stars 13 forks source link

Add documentation about how to override the `passkeys_authenticatable` for `Devise.add_module` #17

Open tcannonfodder opened 1 year ago

tcannonfodder commented 1 year ago

Previously in #13; I thought the module was not being defined inside the gem, but it's actually defined in: https://github.com/ruby-passkeys/devise-passkeys/blob/main/lib/devise/passkeys.rb#L26

Instead, the template repo overrides the module definition with its implementation-specific definitions, which is what we actually want to happen here; since each app will have to create its own set of controllers.

We should update the README to include documentation about how the step is needed (and why!); and use the code from the template repo as example code

johalloran01 commented 1 year ago

Located in passkeys.rb line 48. Template repo: https://github.com/ruby-passkeys/devise-passkeys-template/blob/main/app/models/user.rb