diff --git a/README.md b/README.md index e60add9..4507b6b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# stagereview +
+ Stage +

Stage

+

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.

+
-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. +

+ npm version + npm downloads + license +

-Try the full Stage experience with GitHub integration at [https://stagereview.app](https://stagereview.app). +--- + +Try the full Stage experience with GitHub integration at [stagereview.app](https://stagereview.app). ## Install @@ -10,8 +20,6 @@ Try the full Stage experience with GitHub integration at [https://stagereview.ap npm install -g stagereview ``` -This installs the `stagereview` command. - Then add the skill to your agent: ```bash @@ -26,14 +34,8 @@ In your AI agent, run: /stage-chapters ``` -This breaks your branch's diff into reviewable "chapters" and opens a local browser window to view the chapters. - -## What it does - -- Splits a local git branch diff into logical review chapters -- Opens a local browser to view the chapters -- Runs entirely on your machine +This organizes your local changes into reviewable chapters and opens a browser UI. Everything happens on your machine. ## License -MIT +[MIT](LICENSE) diff --git a/assets/stage-mark.svg b/assets/stage-mark.svg new file mode 100644 index 0000000..d482283 --- /dev/null +++ b/assets/stage-mark.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file