Reviewing & Editing the Usage section in the README

ruby-passkeys / devise-passkeys

Devise extension to use passkeys instead of passwords

MIT License

172 stars 13 forks source link

Reviewing & Editing the Usage section in the README #19

Closed tcannonfodder closed 1 year ago

tcannonfodder commented 1 year ago

[ ] Improving the header structure for better linking to sections
[ ] Documentation about how/why relying_party and set_relying_party_in_request_env must be implemented by the app for its controllers; example of using a concern to centralize the logic.

johalloran01 commented 1 year ago

@tcannonfodder I can take this issue

johalloran01 commented 1 year ago

@tcannonfodder can I get a clarification on how you want this header structure to be improved? I'm looking through the readme and I'm seeing all major headings utilizing H1 notation for mark down.

Is there some sub headings you want me to improve on?