Skip to content

docs: add README with badges and usage - #11

Merged
jvcorredor merged 1 commit into
mainfrom
discord-add-readme
Sep 12, 2026
Merged

jvcorredor merged 1 commit into
mainfrom
discord-add-readme

Conversation

@jvcorredor

Copy link
Copy Markdown
Contributor

Summary

Adds the repo's first README, kept minimal:

  • One-line description of the bot and a link to CONTEXT.md
  • Badges: latest release, Go version (read from go.mod), and the Lint/Release workflow statuses
  • Slash-command table (/book register, /book update-chapter, /test)
  • Local development (just test, just vet, just build), command install + bot run, and the in-memory storage caveat
  • A short Releases section describing the semantic-release/Conventional Commits flow

All four badge URLs were checked and return 200 (release: v0.1.1, Go: v1.27.0). Commit is docs:-typed, so merging it will not cut a release.

No issue: requested directly as a standalone docs change.

Minimal README covering the bot's purpose, slash commands, local
development, and automated releases. Badges: latest release, Go
version, lint, and release workflows.
@jvcorredor
jvcorredor merged commit 2d83a3c into main Sep 12, 2026
4 checks passed
@jvcorredor
jvcorredor deleted the discord-add-readme branch September 12, 2026 17:40
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.

1 participant