mdts 0.4.3 → 0.4.5

package/README.md

@@ -2,86 +2,56 @@
   <img src="docs/logo.svg" alt="mdts" width="400">
 </h1>
 
-`mdts` (MarkDown Tree Server) is a simple command-line tool that serves Markdown files from a specified local directory and provides a web-based interface to browse and view them. It automatically opens the served content in your default web browser.
+**A zero-config CLI tool to preview your local Markdown files in a browser.**  **`npx mdts` — and you're done.**
 
-## Features
+<p align="center">
+  <img src="docs/screen_animation.gif" width="600" alt="mdts demo">
+</p>
 
-- **File Tree Navigation**: Provides a hierarchical view of your Markdown files for easy browsing.
-- **Markdown Rendering**: Renders Markdown files in a clean, readable format.
-- **Live Reload**: Automatically reloads the page in the browser when Markdown files are changed on disk. 
+## 🔧 Features
 
-![screenshot](docs/screenshot.png)
+- ⚡ **Instant Markdown Preview** – Run and view in seconds  
+- 🌐 **Web UI** – Clean, tree-based browser interface  
+- 🔄 **Live Reload** – Automatically refreshes on file changes  
+- 🧘 **Zero Setup** – No config, no install, no nonsense  
 
 
-## Usage
+## 🚀 Quick Start
+
 ```bash
 npx mdts
 ```
 
-By default, `mdts` will serve files from the current directory (`.`) on port `8521`. It will automatically open a new tab in your web browser pointing to `http://localhost:8521`.
+This starts a local server at http://localhost:8521 and opens your browser.
+Your current directory becomes a browsable Markdown tree.
 
-### Options
+## 💡 Use Cases
 
-You can specify a different directory and port:
+- Reviewing AI-generated docs  
+- Quickly checking README or note folders  
+- Lightweight local Markdown wiki  
 
--   `-p, --port <port>`: Specify the port to serve on (default: `8521`)
--   `[directory]`: Specify the directory to serve (default: current directory `.`)
+## 🖼 Screenshot
 
-**Example:**
+> Browsable file tree + rendered Markdown with live reload
 
-To serve Markdown files from the `docs` directory on port `3000`:
+<p align="center">
+  <img src="docs/screenshot.png" width="800" alt="mdts screenshot">
+</p>
 
-```bash
-npx mdts docs -p 3000
-```
+## 📦 Requirements
 
-### Advanced Usage Examples
-Here are some practical scenarios where `mdts` can be useful:
-
--   **AI-powered documentation workflow:**
-    Leverage AI tools to generate or refine your documentation. As the AI produces content, use `mdts` to instantly preview the generated Markdown files locally. This allows for a rapid feedback loop, enabling you to review, edit, and iterate on AI-generated documentation in real-time within your browser, ensuring accuracy and adherence to your project's style before committing changes.
-    ```bash
-    # Assuming your AI-generated docs are in a 'docs-ai' directory
-    npx mdts docs-ai
-    ```
-    This setup provides a seamless way to integrate AI into your documentation pipeline, making the process of creating and maintaining comprehensive project documentation more efficient.
-
--   **Exploring a new project's documentation:**
-    When joining a new project, you often need to quickly understand its structure and documentation. Running `mdts` at the project root can give you an immediate overview of all Markdown-based documentation (e.g., `README.md`, `CONTRIBUTING.md`, `docs/`).
-    ```bash
-    # Navigate to your new project's root directory
-    cd /path/to/new-project
-    npx mdts .
-    ```
-    This provides a convenient way to browse all project-related Markdown files without opening them individually in a text editor.
-
--   **Browsing a collection of Markdown notes/documents:**
-    If you have a repository where you collect Markdown files exported from various sources (e.g., Notion, Evernote, Confluence), `mdts` can help you browse them easily.
-    ```bash
-    npx mdts ~/my-markdown-collection
-    ```
-    This will serve all Markdown files in `~/my-markdown-collection` and its subdirectories, allowing you to navigate through them in your browser.
-
--   **Reviewing `README` files of installed `node_modules`:**
-    Sometimes you might want to quickly check the `README.md` of a library installed in your `node_modules` directory to understand its usage or features.
-    ```bash
-    npx mdts node_modules
-    ```
-    This will serve the `node_modules` directory, allowing you to browse the `README.md` files of your installed packages directly in your browser.
-
-## Development
-
-To build the project:
+- Node.js
+- No installation needed – uses `npx`
 
-```bash
-npm run build & npm run build:frontend
-```
+## 🛠 Options
 
-To start the server:
 ```bash
-npm start
+npx mdts <directory> --port 3000
 ```
 
-## License
+| Option         | Description                           | Example |
+| -------------- | ------------------------------------- | --------| 
+| `<directory>`  | Specify root directory (default .)    | ./docs  |
+| `--port`       | Change the server port (default 8521) | 8000    |
 
-This project is licensed under the MIT License. See the `LICENSE` file for details.