diff --git a/README.md b/README.md index d2cddc7..916f11e 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,56 @@ A Claude Code skill that enforces a disciplined Gitflow-based development workfl ## Installation -Copy the `SKILL.md` file to your global Claude Code skills directory: +Clone the repo and run the install script for your platform. The script creates a **symlink**, so the skill stays in sync with the repo automatically. + +### Linux + +```bash +git clone https://github.com/qubernetic-org/git-workflow-agent-skill.git +cd git-workflow-agent-skill +./scripts/install_linux.sh +``` + +### macOS + +```bash +git clone https://github.com/qubernetic-org/git-workflow-agent-skill.git +cd git-workflow-agent-skill +./scripts/install_macos.sh +``` + +### Windows (PowerShell) + +```powershell +git clone https://github.com/qubernetic-org/git-workflow-agent-skill.git +cd git-workflow-agent-skill +.\scripts\install_windows.ps1 +``` + +> **Note:** Windows symlinks require Developer Mode enabled or an elevated terminal. The script falls back to a file copy if symlinks are unavailable. + +### Uninstall + +```bash +# Linux +./scripts/install_linux.sh --uninstall + +# macOS +./scripts/install_macos.sh --uninstall +``` + +```powershell +# Windows +.\scripts\install_windows.ps1 -Uninstall +``` + +### Manual Installation + +If you prefer not to use the scripts: ```bash mkdir -p ~/.claude/skills/git-workflow -cp SKILL.md ~/.claude/skills/git-workflow/SKILL.md +ln -s "$(pwd)/SKILL.md" ~/.claude/skills/git-workflow/SKILL.md ``` The skill will be automatically discovered on the next Claude Code session.