From f81f82e898f32fa91ef7cb3718c3dafe94c74762 Mon Sep 17 00:00:00 2001 From: Mithun Gowda B Date: Thu, 17 Jul 2025 12:55:55 +0530 Subject: [PATCH] Update README.md Signed-off-by: Mithun Gowda B --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.md b/README.md index 7976999..c5dce07 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,56 @@ git clone https://github.com/NomenAK/SuperClaude.git cd SuperClaude pip install . ``` +## 🔧 UV / UVX Setup Guide +SuperClaude v3 also supports installation via [`uv`](https://github.com/astral-sh/uv) (a faster, modern Python package manager) or `uvx` for cross-platform usage. + +### 🌀 Install with `uv` + +Make sure `uv` is installed: + +```bash +curl -Ls https://astral.sh/uv/install.sh | sh +``` + +> Or follow instructions from: [https://github.com/astral-sh/uv](https://github.com/astral-sh/uv) + +Once `uv` is available, you can install SuperClaude like this: + +```bash +uv venv +source .venv/bin/activate +uv pip install SuperClaude +``` + +### ⚡ Install with `uvx` (Cross-platform CLI) + +If you’re using `uvx`, just run: + +```bash +uvx pip install SuperClaude +``` + +### ✅ Finish Installation + +After installing, continue with the usual installer step: + +```bash +python3 -m SuperClaude install +``` + +Or using bash-style CLI: + +```bash +SuperClaude install +``` + +### 🧠 Note: + +* `uv` provides better caching and performance. +* Compatible with Python 3.8+ and works smoothly with SuperClaude. + +--- **Missing Python?** Install Python 3.7+ first: ```bash # Linux (Ubuntu/Debian)