docs: create README for goauth#1
Merged
Merged
Conversation
Agent-Logs-Url: https://github.com/amalgamated-tools/goauth/sessions/cb7ddbfe-f67e-4139-9b6d-671c7ca36b99 Co-authored-by: veverkap <22348+veverkap@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
veverkap
April 16, 2026 18:06
View session
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repository had an empty README with no documentation. This adds a complete reference covering all three packages.
Changes
authpackage —JWTManager,Middleware/AdminMiddleware,RateLimiter(including trusted-proxy config), and crypto utilities (HashHighEntropyToken,GenerateRandomHex,SecretEncrypter)UserStore,APIKeyStore,PasskeyStorewith sentinel error contracts (sql.ErrNoRows,auth.ErrEmailExists)handlerpackage — route tables and config structs forAuthHandler,OIDCHandler(PKCE + account-linking flow),APIKeyHandler, andPasskeyHandler(discoverable WebAuthn login)smtppackage — environment variable reference andLoadConfig/Validate/Sendusage