docs: update README Usage #270
Conversation
README.md
Outdated
| if !user.webauthn_id | ||
| user.update!(webauthn_id: WebAuthn.generate_user_id) | ||
| end | ||
|
|
||
| create_options = WebAuthn::Credential.create_options( |
There was a problem hiding this comment.
These are meant to be the "options for the create function"...
Wonder if create_options might make you feel its actually "creating options", instead of returning the "options for the create".
Maybe WebAuthn::Credential.options_for_create is better and less prone to confusion.
Even WebAuthn::Credential.registration_options maybe.
There was a problem hiding this comment.
I completely agree that create_options and get_options might be a bit ambiguous—especially get_options.
Given the consistency with the client API, I'd be inclined to go for options_for_create and options_for_get.
There was a problem hiding this comment.
Yeah...
Thanks for the feedback!
README.md
Outdated
|
|
||
| ```ruby | ||
| get_options = WebAuthn::Credential.get_options(allow: credential_id) | ||
| get_options = WebAuthn::Credential.get_options(allow: user.credentials.map { |c| c.webauthn_id }) |
There was a problem hiding this comment.
Same here about .get_options.
Would .options_for_get or authentication_options be less confusing?
Closes #244