revamping readme (#522)

README.md

@@ -28,13 +28,22 @@ Using the research model is optional but highly recommended. You will need at le
 
 ## Quick Start
 
-### Option 1 | MCP (Recommended):
+### Option 1: MCP (Recommended)
 
-MCP (Model Control Protocol) provides the easiest way to get started with Task Master directly in your editor.
+MCP (Model Control Protocol) lets you run Task Master directly from your editor.
 
-1. **Add the MCP config to your editor** (Cursor recommended, but it works with other text editors):
+#### 1. Add your MCP config at the following path depending on your editor
 
-```json
+| Editor       | Scope   | Linux/macOS Path                      | Windows Path                                      | Key          |
+| ------------ | ------- | ------------------------------------- | ------------------------------------------------- | ------------ |
+| **Cursor**   | Global  | `~/.cursor/mcp.json`                  | `%USERPROFILE%\.cursor\mcp.json`                  | `mcpServers` |
+|              | Project | `<project_folder>/.cursor/mcp.json`   | `<project_folder>\.cursor\mcp.json`               | `mcpServers` |
+| **Windsurf** | Global  | `~/.codeium/windsurf/mcp_config.json` | `%USERPROFILE%\.codeium\windsurf\mcp_config.json` | `mcpServers` |
+| **VS Code**  | Project | `<project_folder>/.vscode/mcp.json`   | `<project_folder>\.vscode\mcp.json`               | `servers`    |
+
+##### Cursor & Windsurf (`mcpServers`)
+
+```jsonc
 {
 	"mcpServers": {
 		"taskmaster-ai": {
@@ -56,23 +65,75 @@ MCP (Model Control Protocol) provides the easiest way to get started with Task M
 }
 ```
 
-2. **Enable the MCP** in your editor
+> 🔑 Replace `YOUR_…_KEY_HERE` with your real API keys. You can remove keys you don't use.
 
-3. **Prompt the AI** to initialize Task Master:
+##### VS Code (`servers` + `type`)
 
-```
-Can you please initialize taskmaster-ai into my project?
+```jsonc
+{
+	"servers": {
+		"taskmaster-ai": {
+			"command": "npx",
+			"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",
+				"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"
+			},
+			"type": "stdio"
+		}
+	}
+}
 ```
 
-4. **Use common commands** directly through your AI assistant:
+> 🔑 Replace `YOUR_…_KEY_HERE` with your real API keys. You can remove keys you don't use.
+
+#### 2. (Cursor-only) Enable Taskmaster MCP
+
+Open Cursor Settings (Ctrl+Shift+J) ➡ Click on MCP tab on the left ➡ Enable task-master-ai with the toggle
+
+#### 3. (Optional) Configure the models you want to use
+
+In your editor’s AI chat pane, say:
 
 ```txt
-Can you parse my PRD at scripts/prd.txt?
-What's the next task I should work on?
-Can you help me implement task 3?
-Can you help me expand task 4?
+Change the main, research and fallback models to <model_name>, <model_name> and <model_name> respectively.
 ```
 
+[Table of available models](docs/models.md)
+
+#### 4. Initialize Task Master
+
+In your editor’s AI chat pane, say:
+
+```txt
+Initialize taskmaster-ai in my project
+```
+
+#### 5. Make sure you have a PRD in `<project_folder>/scripts/prd.txt`
+
+An example of a PRD is located into `<project_folder>/scripts/example_prd.txt`.
+
+**Always start with a detailed PRD.**
+
+The more detailed your PRD, the better the generated tasks will be.
+
+#### 6. Common Commands
+
+Use your AI assistant to:
+
+- Parse requirements: `Can you parse my PRD at scripts/prd.txt?`
+- Plan next step: `What’s the next task I should work on?`
+- Implement a task: `Can you help me implement task 3?`
+- Expand a task: `Can you help me expand task 4?`
+
+[More examples on how to use Task Master in chat](docs/examples.md)
+
 ### Option 2: Using Command Line
 
 #### Installation