From d2bcbee0c215eed34538e7ad2e8376c70cbacfa1 Mon Sep 17 00:00:00 2001 From: Ralph Khreish <35776126+Crunchyman-ralph@users.noreply.github.com> Date: Sun, 8 Jun 2025 13:49:40 +0200 Subject: [PATCH] chore: small readme nitpicks --- README.md | 34 +++++++++++++++++----------------- scripts/README.md | 38 +++++++++++++++++++------------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 28dbef74..53b68d10 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ [![NPM Downloads](https://img.shields.io/npm/d18m/task-master-ai?style=flat)](https://www.npmjs.com/package/task-master-ai) [![NPM Downloads](https://img.shields.io/npm/dm/task-master-ai?style=flat)](https://www.npmjs.com/package/task-master-ai) [![NPM Downloads](https://img.shields.io/npm/dw/task-master-ai?style=flat)](https://www.npmjs.com/package/task-master-ai) -### By [@eyaltoledano](https://x.com/eyaltoledano), [@RalphEcom](https://x.com/RalphEcom) & [@jasonzhou1993](https://x.com/jasonzhou1993) +## By [@eyaltoledano](https://x.com/eyaltoledano), [@RalphEcom](https://x.com/RalphEcom) & [@jasonzhou1993](https://x.com/jasonzhou1993) -[![Twitter Follow](https://img.shields.io/twitter/follow/eyaltoledano?style=flat)](https://x.com/eyaltoledano) -[![Twitter Follow](https://img.shields.io/twitter/follow/RalphEcom?style=flat)](https://x.com/RalphEcom) -[![Twitter Follow](https://img.shields.io/twitter/follow/jasonzhou1993?style=flat)](https://x.com/jasonzhou1993) +[![Twitter Follow](https://img.shields.io/twitter/follow/eyaltoledano)](https://x.com/eyaltoledano) +[![Twitter Follow](https://img.shields.io/twitter/follow/RalphEcom)](https://x.com/RalphEcom) +[![Twitter Follow](https://img.shields.io/twitter/follow/jasonzhou1993)](https://x.com/jasonzhou1993) A task management system for AI-driven development with Claude, designed to work seamlessly with Cursor AI. @@ -54,7 +54,7 @@ MCP (Model Control Protocol) lets you run Task Master directly from your editor. ###### Cursor & Windsurf (`mcpServers`) -```jsonc +```json { "mcpServers": { "taskmaster-ai": { @@ -63,16 +63,16 @@ MCP (Model Control Protocol) lets you run Task Master directly from your editor. "env": { "ANTHROPIC_API_KEY": "YOUR_ANTHROPIC_API_KEY_HERE", "PERPLEXITY_API_KEY": "YOUR_PERPLEXITY_API_KEY_HERE", - "OPENAI_API_KEY": "YOUR_OPENAI_KEY_HERE", + "OPENAI_API_KEY": "YOUR_OPENAI_KEY_HERE", "GOOGLE_API_KEY": "YOUR_GOOGLE_KEY_HERE", "MISTRAL_API_KEY": "YOUR_MISTRAL_KEY_HERE", "OPENROUTER_API_KEY": "YOUR_OPENROUTER_KEY_HERE", "XAI_API_KEY": "YOUR_XAI_KEY_HERE", "AZURE_OPENAI_API_KEY": "YOUR_AZURE_KEY_HERE", - "OLLAMA_API_KEY": "YOUR_OLLAMA_API_KEY_HERE", - }, - }, - }, + "OLLAMA_API_KEY": "YOUR_OLLAMA_API_KEY_HERE" + } + } + } } ``` @@ -80,7 +80,7 @@ MCP (Model Control Protocol) lets you run Task Master directly from your editor. ###### VS Code (`servers` + `type`) -```jsonc +```json { "servers": { "taskmaster-ai": { @@ -88,17 +88,17 @@ MCP (Model Control Protocol) lets you run Task Master directly from your editor. "args": ["-y", "--package=task-master-ai", "task-master-ai"], "env": { "ANTHROPIC_API_KEY": "YOUR_ANTHROPIC_API_KEY_HERE", - "PERPLEXITY_API_KEY": "YOUR_PERPLEXITY_API_KEY_HERE", + "PERPLEXITY_API_KEY": "YOUR_PERPLEXITY_API_KEY_HERE", "OPENAI_API_KEY": "YOUR_OPENAI_KEY_HERE", "GOOGLE_API_KEY": "YOUR_GOOGLE_KEY_HERE", "MISTRAL_API_KEY": "YOUR_MISTRAL_KEY_HERE", "OPENROUTER_API_KEY": "YOUR_OPENROUTER_KEY_HERE", "XAI_API_KEY": "YOUR_XAI_KEY_HERE", - "AZURE_OPENAI_API_KEY": "YOUR_AZURE_KEY_HERE", + "AZURE_OPENAI_API_KEY": "YOUR_AZURE_KEY_HERE" }, - "type": "stdio", - }, - }, + "type": "stdio" + } + } } ``` @@ -207,7 +207,7 @@ For more detailed information, check out the documentation in the `docs` directo ## Troubleshooting -### If `task-master init` doesn't respond: +### If `task-master init` doesn't respond Try running it with Node directly: diff --git a/scripts/README.md b/scripts/README.md index 1b83c635..8cfe88b9 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -382,25 +382,25 @@ The output report structure is: ```json { - "meta": { - "generatedAt": "2023-06-15T12:34:56.789Z", - "tasksAnalyzed": 20, - "thresholdScore": 5, - "projectName": "Your Project Name", - "usedResearch": true - }, - "complexityAnalysis": [ - { - "taskId": 8, - "taskTitle": "Develop Implementation Drift Handling", - "complexityScore": 9.5, - "recommendedSubtasks": 6, - "expansionPrompt": "Create subtasks that handle detecting...", - "reasoning": "This task requires sophisticated logic...", - "expansionCommand": "node scripts/dev.js expand --id=8 --num=6 --prompt=\"Create subtasks...\" --research" - } - // More tasks sorted by complexity score (highest first) - ] + "meta": { + "generatedAt": "2023-06-15T12:34:56.789Z", + "tasksAnalyzed": 20, + "thresholdScore": 5, + "projectName": "Your Project Name", + "usedResearch": true + }, + "complexityAnalysis": [ + { + "taskId": 8, + "taskTitle": "Develop Implementation Drift Handling", + "complexityScore": 9.5, + "recommendedSubtasks": 6, + "expansionPrompt": "Create subtasks that handle detecting...", + "reasoning": "This task requires sophisticated logic...", + "expansionCommand": "node scripts/dev.js expand --id=8 --num=6 --prompt=\"Create subtasks...\" --research" + } + // More tasks sorted by complexity score (highest first) + ] } ```