Skip to content

Improve README.md - #14

Merged
jmfrees merged 1 commit into
mainfrom
jmfrees/improve-readme
Jan 2, 2026
Merged

jmfrees merged 1 commit into
mainfrom
jmfrees/improve-readme

Conversation

@jmfrees

@jmfrees jmfrees commented Jan 2, 2026

Copy link
Copy Markdown
Owner

This pull request updates the README.md to provide more comprehensive documentation and improve clarity for users of the go-enumr project. The changes include the addition of project badges, clearer installation instructions, expanded usage guidance, improved examples, and new sections on inspiration and contributing guidelines.

Documentation improvements:

  • Added project badges for Go Report Card, Go Reference, and CI status at the top of the README.md to provide quick project health and reference information.
  • Added a new "When to use go-enumr" section to help users decide when to use this tool versus alternatives like stringer or go-enum.
  • Expanded installation instructions to include both Go 1.24+ tool dependency tracking and global installation, with usage examples for each.
  • Improved and clarified syntax and usage examples, including updates to example code and explanations for both generated and manual enum modes. [1] [2]
  • Added new "Inspiration" and "Contributing" sections to acknowledge related projects and provide guidelines for contributors.

Add some nice-to-have details and features.
@jmfrees
jmfrees merged commit 72f4137 into main Jan 2, 2026
1 check passed
@jmfrees
jmfrees deleted the jmfrees/improve-readme branch January 2, 2026 17:52
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