Skip to content

docs: update README with logo, badges, and cleaner copy#38

Merged
dastratakos merged 2 commits into
mainfrom
dastratakos/update-readme
May 7, 2026
Merged

docs: update README with logo, badges, and cleaner copy#38
dastratakos merged 2 commits into
mainfrom
dastratakos/update-readme

Conversation

@dastratakos
Copy link
Copy Markdown
Contributor

@dastratakos dastratakos commented May 7, 2026

Summary

Refreshes the README with a centered Stage logo, npm badges (version, downloads, license), and streamlined copy.

Changes

  • Add centered Stage logo header sourced from assets/stage-mark.svg
  • Add npm version, downloads, and license badges
  • Consolidate description and "What it does" section into concise copy
  • Remove redundant lines ("This installs the stagereview command")
  • Link LICENSE file from the license section
  • Add assets/stage-mark.svg (the Stage mark)

Testing

Visual inspection of the rendered README on GitHub.


Open in Stage

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md with a new centered header layout, including a logo and badges, and adds the stage-mark.svg asset. The review feedback points out that nesting an

tag inside a

tag is invalid HTML and suggests using a

with align="center" to ensure correct rendering of the header elements.

Comment thread README.md Outdated
@dastratakos dastratakos marked this pull request as ready for review May 7, 2026 07:00
<h1> inside <p> is invalid HTML — browsers auto-close the paragraph,
breaking the centered layout.
@dastratakos dastratakos merged commit 218bf2c into main May 7, 2026
5 checks passed
@dastratakos dastratakos deleted the dastratakos/update-readme branch May 7, 2026 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant