📄 docs: Add readme

README.md

@@ -1,71 +1,94 @@
-# vscode-project-roadmap README
+# VSCode Project Roadmap
 
-This is the README for your extension "vscode-project-roadmap". After writing up a brief description, we recommend including the following sections.
+A Visual Studio Code extension to visualize and track your project's progress by phase using a Markdown checklist file. Perfect for teams and solo developers who want a clear, interactive roadmap directly in their editor.
-
-## Features
-
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
-
-For example if there is an image subfolder under your extension project workspace:
-
-\!\[feature X\]\(images/feature-x.png\)
-
-> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
-
-## Requirements
-
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
-
-## Extension Settings
-
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
-
-For example:
-
-This extension contributes the following settings:
-
-* `myExtension.enable`: Enable/disable this extension.
-* `myExtension.thing`: Set to `blah` to do something.
-
-## Known Issues
-
-Calling out known issues can help limit users opening duplicate issues against your extension.
-
-## Release Notes
-
-Users appreciate release notes as you update your extension.
-
-### 1.0.0
-
-Initial release of ...
-
-### 1.0.1
-
-Fixed issue #.
-
-### 1.1.0
-
-Added features X, Y, and Z.
 
 ---
 
-## Following extension guidelines
+## Features
 
-Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
+- **Roadmap Sidebar:** View your project phases and tasks as a collapsible tree in the VS Code sidebar.
+- **Markdown Integration:** Uses a customizable Markdown checklist file (default: `Development Checklist.md`) for easy editing and version control.
+- **Checkbox Sync:** Toggle tasks as complete/incomplete directly from the tree view—updates your Markdown file instantly.
+- **Progress Indicators:** See completion bars and checkmarks for each phase at a glance.
+- **Webview Overview:** Open a tab with a clean, read-only summary of your roadmap and progress.
+- **Customizable Filename:** Change the checklist file via settings to fit any workflow.
 
-* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
+---
 
-## Working with Markdown
+## Screenshots
 
-You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
+To come
 
-* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
+---
-* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
-* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
 
-## For more information
+## Requirements
 
-* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
+- Visual Studio Code v1.101.0 or higher
-* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
 
-**Enjoy!**
+---
+
+## Extension Settings
+
+This extension contributes the following settings:
+
+| Setting                       | Description                                              | Default                    |
+|-------------------------------|----------------------------------------------------------|----------------------------|
+| `roadmapChecklist.filename`   | The relative path to the Markdown file used for roadmap. | `Development Checklist.md` |
+
+You can change this in your workspace settings to use a different checklist file.
+
+---
+
+## Usage
+
+1. **Prepare your checklist:**
+   Use a Markdown file with phases as headings (`## Phase Name`) and tasks as checkboxes:
+
+   ```markdown
+   ## Phase 1: Planning
+   - [ ] Define requirements
+   - [x] Set up repository
+
+   ## Phase 2: Development
+   - [ ] Implement feature X
+   - [ ] Write tests
+
+   ```
+
+2. **Open the Roadmap Sidebar:**
+Click the "Roadmap" icon in the Activity Bar to view and interact with your checklist.
+3. **Toggle tasks:**
+Click checkboxes in the tree to mark tasks as complete/incomplete.
+4. **View overview:**
+Right-click a phase or use the command palette to open the roadmap overview tab.
+
+---
+
+## Known Issues
+
+- Only supports checklists in Markdown files with - [ ] or - [x] syntax.
+- Nested tasks are supported via indentation, but only one level deep is recommended for clarity.
+
+---
+
+## Release Notes
+
+0.0.1
+Initial release: Roadmap sidebar, checklist sync, overview tab, and settings.
+
+---
+
+## Contributing
+
+Pull requests and suggestions are welcome! Please open an issue to discuss your ideas.
+
+---
+
+## Resources
+
+- Extension Guidelines
+- Markdown Syntax Reference
+
+---
+
+**Enjoy tracking your project roadmap in VS Code!**