Skip to content

docs: add README and godoc comments#8

Merged
catgoose merged 1 commit intomainfrom
docs/readme-and-godoc
Mar 31, 2026
Merged

docs: add README and godoc comments#8
catgoose merged 1 commit intomainfrom
docs/readme-and-godoc

Conversation

@catgoose
Copy link
Copy Markdown
Owner

Summary

  • Add comprehensive README with install instructions, CSRF protection setup, session settings usage, crooner integration pattern, standalone usage, and architecture diagram
  • Add godoc comments to all exported types, interfaces, functions, fields, and constants including package-level documentation

Closes #2
Closes #3

Add comprehensive README covering CSRF protection, session settings,
crooner integration, and standalone usage with architecture diagram.

Add godoc comments to all exported types, interfaces, functions, fields,
and constants. Add package-level doc explaining the interface-driven
design.

Refs #2, #3
@catgoose catgoose merged commit d53dccb into main Mar 31, 2026
2 checks passed
@catgoose catgoose deleted the docs/readme-and-godoc branch March 31, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add godoc comments to all exported types and functions docs: add README with usage examples

1 participant