Improve README with comprehensive documentation - #1
Open
benoahriz wants to merge 2 commits into
Open
Conversation
benoahriz
commented
Nov 27, 2025
benoahriz
commented
Owner
- Added clear description and feature highlights
- Included installation instructions (go install, binary, source)
- Added detailed usage section with command-line flags table
- Provided 4 comprehensive examples covering common use cases
- Documented all available template functions (env, expandenv, Sprig)
- Added use cases section for Docker, Kubernetes, CI/CD
- Included development and contribution guidelines
- Fixed typo: "exmaples" -> "examples"
- Reorganized TODO section with checkboxes and added new items
- Added clear description and feature highlights - Included installation instructions (go install, binary, source) - Added detailed usage section with command-line flags table - Provided 4 comprehensive examples covering common use cases - Documented all available template functions (env, expandenv, Sprig) - Added use cases section for Docker, Kubernetes, CI/CD - Included development and contribution guidelines - Fixed typo: "exmaples" -> "examples" - Reorganized TODO section with checkboxes and added new items
- Strategic vision: simplicity + security differentiator - Competitive analysis vs gomplate and envchain - 4-phase roadmap with detailed feature specifications - Secret management as key differentiator (keychain integration) - Modernization plan: Go modules, Cobra, better error handling - Architecture design with package structure - Migration path from v1.x - Success metrics and timeline (~6 months to v2.3) Key Features Planned: - Native OS keychain integration for secrets - Multi-template processing - Config file support (.envtoconf.yaml) - Enhanced error messages with context - Output validation (YAML/JSON) - Dry-run and analysis modes
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
2 participants
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.