From 72b66e86575f4bde19ee48071ca1eb808e51d49d Mon Sep 17 00:00:00 2001 From: Amolith Date: Mon, 22 Sep 2025 13:26:20 -0600 Subject: [PATCH] docs: update README installation instructions Co-Authored-By: Crush --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 773e70b36f0ca27f1b0fe1e21ba4389ad3c9442d..8fff2f5c49812bb685b362ac390f7eb4a029385e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,14 @@ The server provides seven essential planning tools: ## Installation ```bash +# Download and build using the go tool +go install git.secluded.site/planning-mcp-server@latest + +# Build from the cloned source code +git clone https://git.secluded.site/planning-mcp-server.git +cd planning-mcp-server go build -o planning-mcp-server ./cmd/planning-mcp-server +mv planning-mcp-server ~/.local/bin # assuming ~/.local/bin is in your shell's PATH ``` ## Configuration @@ -31,7 +38,7 @@ go build -o planning-mcp-server ./cmd/planning-mcp-server Generate an example configuration file: ```bash -./planning-mcp-server --generate-config +planning-mcp-server --generate-config ``` This creates `planning-mcp-server.toml` with default settings: @@ -60,7 +67,7 @@ history_enabled = true For use with MCP clients like Claude Desktop: ```bash -./planning-mcp-server --mode stdio +planning-mcp-server --mode stdio ``` ### HTTP Mode @@ -68,13 +75,13 @@ For use with MCP clients like Claude Desktop: For web-based integrations: ```bash -./planning-mcp-server --mode http --port 8080 +planning-mcp-server --mode http --port 8080 ``` ### CLI Options ```bash -./planning-mcp-server --help +planning-mcp-server --help ``` - `--config, -c`: Configuration file path