markdown-review 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,10 +1,29 @@
1
- # markdown-review
1
+ <p align="center">
2
+ <img src="../vscode/images/logo.png" width="160" height="160" alt="Plan Review logo">
3
+ </p>
2
4
 
3
- [![npm version](https://img.shields.io/npm/v/markdown-review)](https://www.npmjs.com/package/markdown-review)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/rwoll/markdown-review/blob/main/LICENSE)
5
+ <h1 align="center">markdown-review</h1>
5
6
 
6
- > Interactive markdown plan review UI — annotate sections, answer AI-agent
7
- > embedded questions, and export structured feedback.
7
+ <p align="center">
8
+ <a href="https://www.npmjs.com/package/markdown-review"><img src="https://img.shields.io/npm/v/markdown-review" alt="npm version"></a>
9
+ <a href="https://github.com/rwoll/markdown-review/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
10
+ </p>
11
+
12
+ <p align="center">
13
+ <strong>Interactive markdown plan review UI — annotate sections, answer AI-agent embedded questions, and export structured feedback.</strong>
14
+ </p>
15
+
16
+ ---
17
+
18
+ ## Screenshot
19
+
20
+ ![Plan Review showing an API spec with annotations in the sidebar and the comment drawer open](../vscode/images/hero-screenshot.png)
21
+
22
+ ### Demo
23
+
24
+ ![Demo of the Plan Review annotation workflow](../vscode/images/hero-demo.gif)
25
+
26
+ ---
8
27
 
9
28
  `markdown-review` is a zero-install CLI that opens a local browser UI for
10
29
  reviewing markdown plans. It is part of the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "markdown-review",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "description": "Interactive markdown plan review UI — annotate, answer questions, export feedback",
5
5
  "author": "rwoll <ross.wollman@gmail.com>",
6
6
  "type": "module",