docs: update README.md

Author: messkan

.github/workflows/pylint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}

README.md

@@ -12,6 +12,33 @@ Available on PyPI: https://pypi.org/project/rag-chunk/
 - ✅ CLI with table/JSON/CSV output formats
 - ✅ Realistic example corpus included
 
+### Demo
+[View the demo](assets/demo.gif)
+
+## 🚀 Roadmap
+
+`rag-chunk` is actively developed! Here's the plan to move from a basic tool to a full-featured chunking workbench.
+
+### ✅ Version 0.1 – Launched
+* [x] Core CLI engine (`click`)
+* [x] Markdown (`.md`) file parsing (`mistune`)
+* [x] Basic chunking strategies: `fixed-size` and `paragraph` (word-based)
+* [x] Evaluation harness: calculate **Recall score** from a `test-file.json`
+* [x] **PyPI Publication:** Installable via `pip install rag-chunk`
+
+### 🎯 Version 0.2 – In Progress
+* [x] CLI output formatting (`rich` tables)
+* [x] **Demo GIF:** Showcase the tool in action in the README
+* [ ] **`tiktoken` Support:** Add `--use-tiktoken` flag for precise, token-based chunking
+* [ ] CLI/UX improvements and bug fixes
+
+### 📈 Version 1.0 – Planned
+* [ ] **More Strategies:** Add advanced strategies like `RecursiveCharacterTextSplitter`, `HierarchicalChunker`
+* [ ] **More File Types:** Support `.txt`, `.rst`, and other plain text formats
+* [ ] **Export & Logging:** Save results as JSON/CSV, optional MLFlow integration
+* [ ] **Benchmarking Mode:** Compare chunking strategies automatically
+
+
 ### Installation
 ```bash
 pip install rag-chunk

demo.gif

@@ -15,10 +15,10 @@
     from rich.table import Table
 
     RICH_AVAILABLE = True
-    console = Console()
+    CONSOLE = Console()
 except ImportError:  # pragma: no cover - optional dependency
     RICH_AVAILABLE = False
-    console = None
+    CONSOLE = None
 
 
 def write_chunks(chunks, strategy: str):
@@ -151,7 +151,7 @@ def _write_results(results, detail, output):
                     pct_cell,
                     str(r.get("saved", "")),
                 )
-            console.print(table)
+            CONSOLE.print(table)
             return
         print(format_table(results))
         return