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
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]>
0 commit comments