You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README to reflect new build tools and release automation (#12)
* update README to reflect new build tools and release automation
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]>
* remove installation prerequisites and TLS interception sections from 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]>
---------
Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com>
Co-authored-by: f0ssel <[email protected]>
0 commit comments