@qzoft/check-list 1.0.0 → 1.0.2

package/README.md

@@ -1,7 +1,9 @@
-# check-list
+# @qzoft/check-list
 
 A general-purpose MCP App that discovers and displays checklists from **all markdown files** in your project, rendered as an interactive checkbox UI inside VS Code Copilot Chat. Changes are saved automatically — no confirmation needed.
 
+Available on npm: [`@qzoft/check-list`](https://www.npmjs.com/package/@qzoft/check-list)
+
 ## Prerequisites
 
 - Node.js 18+
@@ -9,25 +11,22 @@ A general-purpose MCP App that discovers and displays checklists from **all mark
 
 ## Setup
 
-1. Clone this repo:
-   ```sh
-   git clone https://github.com/qzoft/check-list.git
-   cd check-list
-   ```
-
-2. Install dependencies:
-   ```sh
-   npm install
-   ```
+Add the following to your project's `.vscode/mcp.json`:
 
-3. Build the project:
-   ```sh
-   npm run build
-   ```
+```json
+{
+  "servers": {
+    "check-list": {
+      "command": "npx",
+      "args": ["-y", "@qzoft/check-list"]
+    }
+  }
+}
+```
 
-4. Open VS Code — the `.vscode/mcp.json` config auto-registers the server. VS Code will pick it up automatically when you open the workspace.
+That's it — VS Code will download and run the server automatically. No cloning or building required.
 
-5. In Copilot Chat, ask **"show my tasks"** → the `list_tasks` tool scans the project and renders the interactive checkbox UI.
+In Copilot Chat, ask **"show my tasks"** → the `list_tasks` tool scans the project and renders the interactive checkbox UI.
 
 ## Usage
 
@@ -69,26 +68,9 @@ Once the server is running, you can use two tools in Copilot Chat:
 | Variable      | Description                                         | Example                          |
 |---------------|-----------------------------------------------------|----------------------------------|
 | `PROJECT_DIR` | Root directory to scan for markdown files            | `~/repos/my-project`             |
-| `TASK_FILE`   | *(backward-compat)* Falls back to parent directory   | `~/repos/my-project/task.md`     |
 
 If neither is set, the server uses the current working directory.
 
-The project directory is configured in `.vscode/mcp.json`:
-
-```json
-{
-  "servers": {
-    "check-list": {
-      "command": "node",
-      "args": ["dist/server.js"],
-      "env": {
-        "PROJECT_DIR": "${workspaceFolder}"
-      }
-    }
-  }
-}
-```
-
 ## Task file format
 
 The parser recognizes `## Section` headers and checkbox list items in any `.md` file:
@@ -99,7 +81,7 @@ The parser recognizes `## Section` headers and checkbox list items in any `.md`
 - [ ] Update README
 
 ## This Week
-- [ ] Review PRs
+- [x] Review PRs
 - [ ] Deploy to staging
 ```
 
@@ -110,12 +92,10 @@ The server skips common non-project directories (`node_modules`, `.git`, `dist`,
 ## Project structure
 
 ```
-check-list/
+@qzoft/check-list
 ├── package.json
 ├── tsconfig.json
 ├── README.md
-├── .vscode/
-│   └── mcp.json          # VS Code MCP server config
 ├── src/
 │   ├── server.ts          # MCP server entry point
 │   ├── parser.ts          # Markdown checkbox parser

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@qzoft/check-list",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "MCP App for interactive task management from markdown files",
   "type": "module",
   "main": "dist/server.js",
-  "bin": "dist/server.js",
-  "files": ["dist", "ui"],
+  "bin": {
+    "check-list": "dist/server.js"
+  },
+  "files": [
+    "dist",
+    "ui"
+  ],
   "scripts": {
     "build": "tsc",
     "start": "node dist/server.js",