doc: update readme #277
Merged
doc: update readme #277
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This pull request significantly enhances the README.md documentation for the go-enum project by adding comprehensive installation instructions, feature highlights, and usage examples. The changes transform a minimal one-line description into a detailed guide that makes the tool more accessible to new users.
- Added structured documentation with table of contents, key features, and quick start guide
- Documented recent features including custom JSON package support, iota disabling, and output suffix customization
- Expanded installation instructions to cover multiple methods (go install, GitHub releases, Docker)
Comments suppressed due to low confidence (3)
README.md:39
- Go 1.23.0 does not exist. As of January 2025, the latest Go version was 1.22.x. Consider using a valid Go version requirement like 'Go 1.19 or later' or verify the actual minimum supported version.
- Go 1.23.0 or later
README.md:206
- The version v0.9.0 may not exist. Verify that this version has been released before documenting it as an example, or use a placeholder like 'vX.Y.Z' with instructions to check available releases.
curl -fsSL "https://github.com/abice/go-enum/releases/download/v0.9.0/go-enum_$(uname -s)_$(uname -m)" -o go-enum
README.md:222
- The Docker tag v0.9.0 may not exist. Verify that this version has been released and tagged in the Docker registry, or use a placeholder version in the example.
docker run -w /app -v $(pwd):/app abice/go-enum:v0.9.0
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.
This pull request updates the
README.mdfile for thego-enumproject, significantly enhancing its documentation. The changes include a detailed introduction to the tool's features, improved instructions for installation and usage, and the addition of new options for customization. Below is a summary of the most important changes:Enhancements to Documentation
go-enum.Recent Features
--jsonpkgoption).iotain generated enums (--no-iotaoption).--output-suffixoption).Installation Options
go install(recommended).Command-Line Options
USAGEsection to simplify the command-line syntax.--jsonpkg,--output-suffix, and--no-iota. [1] [2]