md-review 0.0.5 → 0.0.7

package/README.md

@@ -1,6 +1,6 @@
 # md-review
 
-English | [日本語](./README-ja.md)
+English | [日本語](./README-ja.md) | [简体中文](./README-zh.md)
 
 ![screenshot](./assets/screenshot.png)
 
@@ -11,7 +11,12 @@ Comments can be copied and used as feedback for AI agents.
 
 - Display Markdown in its original format
 - Add comments to specific lines
+- Edit existing comments
 - Select files from tree view
+- Dark mode support (follows system preferences)
+- Resizable and collapsible sidebars
+- Click line numbers in comments to jump to corresponding content
+- Hot reload when markdown files change
 
 ## Install
 
@@ -22,19 +27,56 @@ npm install -g md-review
 ## Usage
 
 ```sh
-md-review README.md
+md-review [options]              # Browse all markdown files in current directory
+md-review <file> [options]       # Preview a specific markdown file
 ```
 
 ### Options
 
 ```sh
--p, --port <port>      Vite server port (default: 6060)
-    --api-port <port>  API server port (default: 3030)
+-p, --port <port>      Server port (default: 3030)
     --no-open          Do not open browser automatically
--h, --help             Show help
--v, --version          Show version
+-h, --help             Show this help message
+-v, --version          Show version number
 ```
 
+### Examples
+
+```sh
+md-review                        # Browse all markdown files in current directory
+md-review README.md              # Preview README.md
+md-review docs/guide.md --port 8080
+```
+
+## Comment Management
+
+### Adding Comments
+1. Select text in the markdown preview
+2. Click the "Comment" button that appears
+3. Type your comment and press `Cmd/Ctrl+Enter` or click "Submit"
+
+### Editing Comments
+1. Click the edit icon (pencil) on any existing comment
+2. Modify the text in the textarea
+3. Press `Cmd/Ctrl+Enter` or click "Save" to save changes
+4. Press `Escape` or click "Cancel" to discard changes
+
+### Keyboard Shortcuts
+- `Cmd/Ctrl+Enter` - Submit/Save comment
+- `Escape` - Cancel editing
+- `Cmd+K` - Focus search bar (in directory mode)
+
+## Hot Module Replacement
+
+md-review automatically watches for changes to markdown files:
+
+- When you edit and save a markdown file, the preview updates automatically
+- No manual browser refresh needed
+- Works in both single file and directory browsing modes
+- File watching uses efficient Server-Sent Events (SSE)
+
+This makes it ideal for live editing workflows and quick iteration on documentation.
+
 ## License
 
 [MIT](./LICENSE)

package/bin/md-review.js

@@ -112,18 +112,25 @@ const serverProcess = spawn('node', ['server/index.js'], {
 });
 
 let serverReady = false;
+let actualPort = port;
 
 // Wait for server to be ready before opening browser
 serverProcess.stdout.on('data', async (data) => {
   process.stdout.write(data);
   const output = data.toString();
 
+  // Extract actual port from "API Server running on http://localhost:XXXX"
+  const portMatch = output.match(/API Server running on http:\/\/localhost:(\d+)/);
+  if (portMatch) {
+    actualPort = parseInt(portMatch[1], 10);
+  }
+
   if (!serverReady && output.includes(SERVER_READY_MESSAGE)) {
     serverReady = true;
 
     if (shouldOpen) {
       const openModule = await import('open');
-      openModule.default(`http://localhost:${port}`);
+      openModule.default(`http://localhost:${actualPort}`);
     }
   }
 });