Fixing typo in README.md

[g-vvv]

Changing location of User intefrace from webauthn/user.go to webauthn/types.go

[coderabbitai]

Walkthrough

This update involves the migration of interface functions that manage credential and authenticator structures from webauthn/user.go to webauthn/types.go. This reorganization aims to streamline the structure and improve the logical grouping of related functionalities in the codebase.

Changes

Files Changed	Summary
webauthn/.../user.go → webauthn/.../types.go	Moved interface functions for handling credential and authenticator structs to a new file.

🐰✨📜
In the land of code, where the bits align,
A rabbit hopped, with changes divine.
From user.go to types they flow,
Structs and funcs, in order they go.
Celebrate we do, with a hop and a cheer,
For cleaner code, the horizon is clear! 🌟📂

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c673c3d and 1b5f96e.

Files selected for processing (1)

• README.md (1 hunks)

Additional Context Used

LanguageTool (28)

README.md (28)

Near line 1: Possible spelling mistake found.
Context: # WebAuthn Library

[![GoDoc](https://godoc.org/...

---

Near line 24: It seems that a pronoun is missing.
Context: ...ally 1 patch release of go, for example if go 1.21.0 is released, we
will likely ...

---

Near line 27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ement of security in a dependent project and we aim to avoid backwards
compatibilit...

---

Near line 28: Possible missing comma found.
Context: ...specially important in a language like
go where their backwards compatibility whe...

---

Near line 40: Consider adding a comma.
Context: ... 0, as per Semantic Versioning 2.0 rules there may be breaking changes without warning...

---

Near line 40: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ...2.0 rules there may be breaking changes without warning.
While we strive to avoid such change...

---

Near line 43: Possible spelling mistake found.
Context: ...fy users they may be unavoidable.

Quickstart

`go get github.com/go-webauthn/webau...

---

Near line 45: This sentence does not start with an uppercase letter.
Context: ...go get github.com/go-webauthn/webauthn` and initialize it in your application with ...

---

Near line 47: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...values.

Make sure your user model is able to handle the interface functions laid out...

---

Near line 47: Possible spelling mistake found.
Context: ...dle the interface functions laid out in webauthn/types.go. This means also
supporting...

---

Near line 48: Possible spelling mistake found.
Context: ...credential and authenticator structs in webauthn/credential.go and
`webauthn/authenti...

---

Near line 48: Possible spelling mistake found.
Context: ...ructs in webauthn/credential.go and
webauthn/authenticator.go, respectively.

...

---

Near line 53: It appears that in this idiom a possessive apostrophe is missing.
Context: ...ow some basic use cases of the library. For consistency sake the following variables are used
to de...

---

Near line 56: Possible spelling mistake found.
Context: ...o denote specific things:

• Variable webAuthn: the webauthn.WebAuthn instance you ...

---

Near line 56: Add a space between sentences.
Context: ...c things:

• Variable webAuthn: the webauthn.WebAuthn instance you initialize elsewhere in y...

---

Near line 57: Possible spelling mistake found.
Context: ...lize elsewhere in your code

• Variable datastore: the pseudocode backend service that s...

---

Near line 57: Possible spelling mistake found.
Context: ...docode backend service that stores your webauthn session data and users such as PostgreS...

---

Near line 58: Possible spelling mistake found.
Context: ... PostgreSQL

• Variable session: the webauthn.SessionData object
• Variable user: ...

---

Near line 58: Add a space between sentences.
Context: ...QL

• Variable session: the webauthn.SessionData object
• Variable user: your webauth...

---

Near line 59: Possible spelling mistake found.
Context: ...ionData object

• Variable user: your webauthn.User implementation

We try to avoid ...

---

Near line 59: Add a space between sentences.
Context: ...bject

• Variable user: your webauthn.User implementation

We try to avoid using...

---

Near line 61: Possible spelling mistake found.
Context: ... specific external libraries (excluding stdlib) where possible, and you'll need to ada...

---

Near line 178: Possible spelling mistake found.
Context: ... by providing optional structs to the
BeginRegistration and BeginLogin functions.

Re...

---

Near line 179: Possible spelling mistake found.
Context: ...tructs to the
BeginRegistration and BeginLogin functions.

Registration modifi...

---

Near line 248: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...y by default does not enforce timeouts. However the default timeouts sent to the browse...

---

Near line 249: Possible spelling mistake. ‘behaviours’ is British English.
Context: ...ication. You can override both of these behaviours however.

package example

i...

---

Near line 249: Consider adding a comma before the interrupter.
Context: ...ou can override both of these behaviours however.

```go
package example

import (
...

---

Near line 291: Possible missing comma found.
Context: ...
implementation. Without their amazing work this library could not exist.


[git...

</blockquote></details>

</blockquote></details>

</details>
<details><summary>Additional comments not posted (1)</summary><blockquote>
<details><summary>README.md (1)</summary><blockquote>

`47-47`: Corrected file reference to `webauthn/types.go`.

This change accurately reflects the location of the interface functions, improving the documentation's accuracy and usefulness for developers.

</blockquote></details></blockquote></details>



</details><!-- commit_ids_reviewed_start -->

<!-- 1b5f96ee8d3cae24128848324c7a8a11926a56ba -->

<!-- commit_ids_reviewed_end --><!-- tips_start -->

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

<details>
<summary>Share</summary>

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

</details>

<details>
<summary>Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai):

- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
   - `I pushed a fix in commit <commit_id>.`
   - `Generate unit testing code for this file.`
   - `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
   - `@coderabbitai generate unit testing code for this file.`
   -	`@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
   - `@coderabbitai generate interesting stats about this repository and render them as a table.`
   - `@coderabbitai show all the console.log statements in this repository.`
   - `@coderabbitai read src/utils.ts and generate unit testing code.`
   - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

### CodeRabbit Commands (invoked as PR comments)

- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai help` to get help.


Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.

### CodeRabbit Configration File (`.coderabbit.yaml`)

- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`

### Documentation and Community

- Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->