From a211fba874e0cde00b08d68e7a365e34f548a6ef Mon Sep 17 00:00:00 2001 From: Timmy Date: Sat, 4 Apr 2026 11:53:10 +0100 Subject: [PATCH] Fixed up README a bit --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3a122034..b450a787 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,14 @@ huskies init --port 3000 This creates a `.huskies/` directory with the pipeline structure, `project.toml`, and `.mcp.json`. The `.mcp.json` file lets Claude Code discover huskies' MCP tools automatically. -3. Open a Claude Code session in the same project directory. Claude will pick up the MCP tools from `.mcp.json`. +Huskies also ships an embedded React frontend. Once the server is running, open `http://localhost:3000` to see the pipeline board, agent status, and chat interface. + +3. Open a Claude Code session in the same project directory, or visit http://localhost:3000/. 4. Tell Claude: "help me set up this project with huskies." Claude will walk you through the setup wizard — generating project context, tech stack docs, and test/release scripts. Review each step and confirm or ask to retry. Once setup is complete, Claude can create stories, start agents, check status, and manage the full pipeline via MCP tools — no commands to memorize. -## Web UI - -Huskies also ships an embedded React frontend. Once the server is running, open `http://localhost:3000` to see the pipeline board, agent status, and chat interface. - ## Chat transports Huskies can be controlled via bot commands in **Matrix**, **WhatsApp**, and **Slack**. Configure a transport in `.huskies/bot.toml` — see the example files: @@ -33,12 +31,14 @@ Huskies can be controlled via bot commands in **Matrix**, **WhatsApp**, and **Sl - `.huskies/bot.toml.whatsapp-twilio.example` - `.huskies/bot.toml.slack.example` -## Prerequisites +## Prerequisites for building - Rust (2024 edition) - Node.js and npm - Docker (for Linux cross-compilation and container deployment) -- `cross` (`cargo install cross`) for Linux static builds +- `cross` (`cargo install cross`) optional, for Linux static builds. Only needed if you are building for a different architecture, e.g. if you want to build a Linux binary from a Mac. + +You only need these installed if you want to build Huskies yourself. Alternately, you can just download and run the `huskies` binary for your system from https://code.crashlabs.io/crashlabs/huskies/releases ## Building for production