docs: update README to reflect new build tools and release automation #12
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
![blink-so[bot]](https://avatars.githubusercontent.com/in/1271127?s=80&v=4){kind=small}
Updated README.md to be accurate with recent changes: ## Installation Section - Added GitHub Releases as primary installation method - Provided download examples for all 4 supported platforms - Updated Go version requirement from 1.21+ to 1.25+ - Reorganized with releases first, build from source second ## Quick Start Section - Added installation options (releases vs build from source) - Updated examples to use 'jail' instead of './jail' (assumes installed) - Mentioned Makefile as build option ## Development Section - Updated to use Makefile targets as primary approach - Added all available make targets (build, build-all, test, etc.) - Kept manual Go commands as secondary option - Added reference to build script for cross-platform builds ## Accuracy Improvements - Corrected Go version requirement to match CI workflows - Added proper installation instructions for all platforms - Made Makefile the recommended development approach - Maintained backward compatibility with direct Go commands The README now accurately reflects the current state of the project with automated releases, Makefile tooling, and proper installation options. Co-authored-by: f0ssel <[email protected]>
…README Simplified README by removing detailed sections: ## Removed Installation Prerequisites - Linux kernel version requirements - iptables/pfctl dependencies - Go version requirements - sudo access notes ## Removed TLS Interception Section - CA certificate storage details - Environment variable explanations - Certificate generation process - Usage examples with --no-tls-intercept ## Kept Essential Information - --no-tls-intercept flag in command-line options (without description) - Core functionality and usage examples - Installation and development instructions Rationale: Users will discover missing dependencies when they try to use the tool. TLS interception details are implementation specifics that users don't need to understand upfront. The README is now more focused and less intimidating for new users. Co-authored-by: f0ssel <[email protected]>
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.
Overview
Updates README.md to accurately reflect the recent changes from the release automation PR, ensuring users have correct and up-to-date information.
📝 Key Updates
📦 Installation Section
🚀 Quick Start Section
jailinstead of./jailmake buildas an option🛠️ Development Section
./scripts/build.shfor cross-platform builds🔍 Accuracy Fixes
./jailjail(assumes installed)🎯 Benefits
Better User Experience
Developer Friendly
Accurate Documentation
🧪 Tested
make buildtested)The README now provides accurate, up-to-date information that matches the current state of the project with automated releases and modern development tooling! 🎉