From 316c2f5585957cff6ef4a82f6cf8004d28b79f72 Mon Sep 17 00:00:00 2001 From: The BROKE Cluster Team Date: Sun, 21 Sep 2025 13:59:00 +0200 Subject: [PATCH] README: Add beta release installation instructions - Add recommended beta installation section with direct GitHub release URL - Simplifies user onboarding for v2.0.0-beta.3 testing - Reorganized Quick Start with clear Development vs Release paths --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 68600df..0d4d006 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,24 @@ MLX Knife has been comprehensively tested and verified on: ## Quick Start +### Beta Release Installation (Recommended) + +```bash +# Install latest beta release directly from GitHub +pip install https://github.com/mzau/mlx-knife/releases/download/v2.0.0-beta.3/mlxk_json-2.0.0b3-py3-none-any.whl + +# Verify installation +mlxk2 --version # → mlxk2 2.0.0b3 +``` + +### Development Installation + ```bash # Installation (local development) git clone https://github.com/mzau/mlx-knife.git cd mlx-knife pip install -e . -``` + # Install with development tools (ruff, mypy, tests) pip install -e ".[dev,test]" ```