backlog.md 1.5.4 → 1.5.6

package/README.md

@@ -36,34 +36,39 @@
 
 ---
 
-### Five‑minute tour
-
-```markdown
-# Make sure you have Backlog.md installed
-bun/npm i -g backlog.md
+## <img src="./.github/5-minute-tour-256.png" alt="5-minute tour" width="28" height="28" align="center"> Five‑minute tour
+```bash
+# 1. Make sure you have Backlog.md installed  
+bun/npm i -g backlog.md or brew install backlog-md
 
-# 1. Bootstrap a repo + backlog
-backlog init hello-
+# 2. Bootstrap a repo + backlog  
+backlog init "My Awesome Project"
 
-# 2. Capture work
+# 3. Capture work  
 backlog task create "Render markdown as kanban"
 
-# 3. See where you stand
-backlog board view
+# 4. See where you stand  
+backlog board view or backlog browser
 
-# 4. Working with AI
+# 5. Create tasks using Claude-code, Gemini, Codex or Jules
 Claude I would like to build a search functionality in the web view that searches for:
 * tasks
 * docs
 * decisions
-Please create relevant tasks to tackle this request.
+  Please create relevant tasks to tackle this request.
+
+# 6. Assign tasks to AI
+Claude please implement all tasks related to the web search functionality (task-10, task-11, task-12)
+* before starting to write code use 'ultrathink mode' to prepare an implementation plan
+* use multiple sub-agents when possible and dependencies allow
 ```
 
-All data is saved under `backlog` folder as human‑readable Markdown with the following format `task-<task-id> - <task-title>.md` (e.g. `task-12 - Fix typo.md`).
+
+All data is saved under `backlog` folder as human‑readable Markdown with the following format `task-<task-id> - <task-title>.md` (e.g. `task-10 - Add core search functionality.md`).
 
 ---
 
-### Web Interface
+## <img src="./.github/web-interface-256.png" alt="Web Interface" width="28" height="28" align="center"> Web Interface
 
 Launch a modern, responsive web interface for visual task management:
 
@@ -90,7 +95,7 @@ The web interface provides:
 
 ---
 
-## CLI reference
+## <img src="./.github/cli-reference-256.png" alt="CLI Reference" width="28" height="28" align="center"> CLI reference
 
 ### Project Setup
 
@@ -149,6 +154,7 @@ When re-initializing an existing project, all current configuration values are p
 |-------------|------------------------------------------------------|
 | Kanban board      | `backlog board` (interactive UI, press 'E' to edit in editor) |
 | Export board | `backlog board export [file]` (exports Kanban board to markdown) |
+| Export with version | `backlog board export --export-version "v1.0.0"` (includes version in export) |
 
 ### Web Interface
 
@@ -198,14 +204,14 @@ Full help: `backlog --help`
 
 ---
 
-## Configuration
+## <img src="./.github/configuration-256.png" alt="Configuration" width="28" height="28" align="center"> Configuration
 
 Backlog.md merges the following layers (highest → lowest):
 
-1. CLI flags  
-2. `backlog/config.yml` (per‑project)  
-3. `~/backlog/user` (per‑user)  
-4. Built‑ins  
+1. CLI flags
+2. `backlog/config.yml` (per‑project)
+3. `~/backlog/user` (per‑user)
+4. Built‑ins
 
 Key options:
 
@@ -228,7 +234,7 @@ Key options:
 
 ---
 
-## Sharing & Export
+## <img src="./.github/sharing-export-256.png" alt="Sharing & Export" width="28" height="28" align="center"> Sharing & Export
 
 ### Board Export
 
@@ -243,6 +249,13 @@ backlog board export project-status.md
 
 # Force overwrite existing file
 backlog board export --force
+
+# Export to README.md with board markers
+backlog board export --readme
+
+# Include a custom version string in the export
+backlog board export --export-version "v1.2.3"
+backlog board export --readme --export-version "Release 2024.12.1-beta"
 ```
 
 Perfect for sharing project status, creating reports, or storing snapshots in version control.
@@ -251,19 +264,20 @@ Perfect for sharing project status, creating reports, or storing snapshots in ve
 
 <!-- BOARD_START -->
 
-## 📊 Backlog.md Project Status (v0.0.0)
+## 📊 Backlog.md Project Status (v1.5.5)
 
 This board was automatically generated by [Backlog.md](https://backlog.md)
 
-Generated on: 2025-07-22 21:05:56
+Generated on: 2025-07-22 21:26:53
 
 | To Do | In Progress | Done |
 | --- | --- | --- |
-| **task-183** - Add ordinal field for custom task ordering in web UI<br>(Assignees: none, Labels: none) | **└─ task-24.1** - CLI: Kanban board milestone view<br>(Assignees: @codex, Labels: none) | **task-198** - Fix markdown content overflow beyond screen width<br>(Assignees: none, Labels: none) |
-| **task-181** - Add statistics dashboard to web UI<br>(Assignees: none, Labels: none) |  | **task-197** - Fix decision page refresh showing blank screen<br>(Assignees: none, Labels: none) |
-| **task-180** - Add statistics overview command to CLI with TUI interface<br>(Assignees: none, Labels: none) |  | **task-196** - Add NixOS packaging support<br>(Assignees: none, Labels: none) |
-| **task-175** - Add hour and minute to all dates in drafts, tasks, documents, decisions<br>(Assignees: none, Labels: none) |  | **task-195** - Fix React Router deep linking for documentation and decisions pages<br>(Assignees: @claude, Labels: bug, routing, react, ux) |
-| **task-172** - Order tasks by status and ID in both web and CLI lists<br>(Assignees: none, Labels: none) |  | **task-194** - Add graceful port handling for browser command<br>(Assignees: @claude, Labels: enhancement, ux, error-handling) |
+| **task-183** - Add ordinal field for custom task ordering in web UI<br>(Assignees: none, Labels: none) | **└─ task-24.1** - CLI: Kanban board milestone view<br>(Assignees: @codex, Labels: none) | **task-199** - Add version parameter to board export command<br>(Assignees: none, Labels: none) |
+| **task-181** - Add statistics dashboard to web UI<br>(Assignees: none, Labels: none) |  | **task-198** - Fix markdown content overflow beyond screen width<br>(Assignees: none, Labels: none) |
+| **task-180** - Add statistics overview command to CLI with TUI interface<br>(Assignees: none, Labels: none) |  | **task-197** - Fix decision page refresh showing blank screen<br>(Assignees: none, Labels: none) |
+| **task-175** - Add hour and minute to all dates in drafts, tasks, documents, decisions<br>(Assignees: none, Labels: none) |  | **task-196** - Add NixOS packaging support<br>(Assignees: none, Labels: none) |
+| **task-172** - Order tasks by status and ID in both web and CLI lists<br>(Assignees: none, Labels: none) |  | **task-195** - Fix React Router deep linking for documentation and decisions pages<br>(Assignees: @claude, Labels: bug, routing, react, ux) |
+|  |  | **task-194** - Add graceful port handling for browser command<br>(Assignees: @claude, Labels: enhancement, ux, error-handling) |
 |  |  | **task-193** - Fix custom markdown editor styles missing in compiled build<br>(Assignees: @kiro, Labels: bug, css, build) |
 |  |  | **task-192** - Fix drag-and-drop not working in web view<br>(Assignees: @claude, Labels: bug, web-ui, high-priority) |
 |  |  | **task-191** - Migrate from Bun.spawn to Bun shell API<br>(Assignees: @gemini, @claude, Labels: refactoring, developer-experience) |
@@ -272,6 +286,6 @@ Generated on: 2025-07-22 21:05:56
 
 <!-- BOARD_END -->
 
-## License
+### License
 
 Backlog.md is released under the **MIT License** – do anything, just give credit. See [LICENSE](LICENSE).

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "backlog.md",
-  "version": "1.5.4",
+  "version": "1.5.6",
   "bin": {
     "backlog": "cli.js"
   },
   "optionalDependencies": {
-    "backlog.md-linux-x64": "1.5.4",
-    "backlog.md-linux-arm64": "1.5.4",
-    "backlog.md-darwin-x64": "1.5.4",
-    "backlog.md-darwin-arm64": "1.5.4",
-    "backlog.md-windows-x64": "1.5.4"
+    "backlog.md-linux-x64": "1.5.6",
+    "backlog.md-linux-arm64": "1.5.6",
+    "backlog.md-darwin-x64": "1.5.6",
+    "backlog.md-darwin-arm64": "1.5.6",
+    "backlog.md-windows-x64": "1.5.6"
   },
   "scripts": {
     "postuninstall": "node postuninstall.cjs"