Skip to content

Commit 218bf2c

Browse files
authored
docs: update README with logo, badges, and cleaner copy (#38)
* docs: update README with logo, badges, and cleaner copy * fix: use div instead of p for block-level heading in README <h1> inside <p> is invalid HTML — browsers auto-close the paragraph, breaking the centered layout.
1 parent aaf88ab commit 218bf2c

2 files changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
1-
# stagereview
1+
<div align="center">
2+
<img src="https://raw.githubusercontent.com/ReviewStage/stage-cli/main/assets/stage-mark.svg" alt="Stage" height="80">
3+
<h1>Stage</h1>
4+
<p>AI-powered code review tool that organizes local code changes into logical chapters and points out what to review before you dive into the code.</p>
5+
</div>
26

3-
AI-powered code review tool that organizes pull requests into logical chapters and surfaces risks before you dive into the code. Run it from your local coding agent of choice.
7+
<p align="center">
8+
<a href="https://www.npmjs.com/package/stagereview"><img src="https://img.shields.io/npm/v/stagereview.svg" alt="npm version"></a>
9+
<a href="https://www.npmjs.com/package/stagereview"><img src="https://img.shields.io/npm/dm/stagereview.svg" alt="npm downloads"></a>
10+
<a href="https://github.com/ReviewStage/stage-cli/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/stagereview.svg" alt="license"></a>
11+
</p>
412

5-
Try the full Stage experience with GitHub integration at [https://stagereview.app](https://stagereview.app).
13+
---
14+
15+
Try the full Stage experience with GitHub integration at [stagereview.app](https://stagereview.app).
616

717
## Install
818

919
```bash
1020
npm install -g stagereview
1121
```
1222

13-
This installs the `stagereview` command.
14-
1523
Then add the skill to your agent:
1624

1725
```bash
@@ -26,14 +34,8 @@ In your AI agent, run:
2634
/stage-chapters
2735
```
2836

29-
This breaks your branch's diff into reviewable "chapters" and opens a local browser window to view the chapters.
30-
31-
## What it does
32-
33-
- Splits a local git branch diff into logical review chapters
34-
- Opens a local browser to view the chapters
35-
- Runs entirely on your machine
37+
This organizes your local changes into reviewable chapters and opens a browser UI. Everything happens on your machine.
3638

3739
## License
3840

39-
MIT
41+
[MIT](LICENSE)

assets/stage-mark.svg

Lines changed: 6 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)