Skip to content

Update README for v1 stable launch#1759

Open
rabanspiegel wants to merge 1 commit intomainfrom
emdash/early-tigers-shine-kfwh8
Open

Update README for v1 stable launch#1759
rabanspiegel wants to merge 1 commit intomainfrom
emdash/early-tigers-shine-kfwh8

Conversation

@rabanspiegel
Copy link
Copy Markdown
Contributor

@rabanspiegel rabanspiegel commented Apr 24, 2026

Summary

  • Update README launch copy from v1 beta to stable v1
  • Point top download buttons to emdash.sh/download and launch post to /blog/emdash-v1-stable
  • Use the v1 beta product screenshot and remove outdated Homebrew/GitHub CLI/native-module FAQ content
  • Rename the provider contribution wording to Providers table

Verification

  • Not run; README-only update per request

Note

Low Risk
Low risk README-only changes (copy, links, and images) with no code or runtime behavior impact.

Overview
Updates the README to reflect the v1 stable launch: download CTAs now point to emdash.sh/download, the launch-post link is updated, and the headline/copy is revised from beta to stable.

Refreshes README content by swapping the product screenshot, removing the Homebrew install callout and a couple outdated FAQ entries (GitHub CLI requirement and native-module crash fix), and tweaks provider-contribution wording to reference the Providers table.

Reviewed by Cursor Bugbot for commit 336e499. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 24, 2026

Greptile Summary

This PR updates the README from v1 beta to stable v1: all three download buttons now point to emdash.sh/download, the launch post link and copy are updated, the product screenshot is swapped, and outdated FAQ entries (Homebrew, GitHub CLI, native-module crash) are removed. The changes are straightforward documentation updates with no code impact.

Confidence Score: 5/5

Safe to merge — documentation-only change with no code impact.

All findings are P2 style/UX suggestions (screenshot URL naming, missing GitHub CLI context). No logic, security, or functional issues introduced.

No files require special attention.

Important Files Changed

Filename Overview
README.md README updated for stable v1 launch: download links point to emdash.sh/download, launch post URL updated, Homebrew/GitHub CLI/native-module FAQ entries removed, product screenshot swapped to v1beta.jpg, and "Integrations matrix" renamed to "Providers table".

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([User visits README]) --> B{Download button}
    B -->|Before PR| C[github.com/generalaction/emdash/releases]
    B -->|After PR| D[emdash.sh/download]
    A --> E{Launch post link}
    E -->|Before PR| F[emdash.sh/blog/public-v1-beta]
    E -->|After PR| G[emdash.sh/blog/emdash-v1-stable]
    A --> H{Product screenshot}
    H -->|Before PR| I[media/readme/product.jpeg]
    H -->|After PR| J[media/blog/public-v1-beta/v1beta.jpg]
    style J fill:#ffe0b2,stroke:#e65100
Loading

Comments Outside Diff (1)

  1. README.md, line 118 (link)

    P2 GitHub CLI setup context removed while reference remains

    The Issues table still tells users to authenticate via gh auth login, but the FAQ entry that explained how to install and sign in with the GitHub CLI was removed in this PR. New users who aren't familiar with gh now have no guidance on how to fulfil that prerequisite. Consider adding a brief inline note (e.g., a parenthetical link to the gh install page) or keeping a condensed version of the auth tip.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: README.md
    Line: 118
    
    Comment:
    **GitHub CLI setup context removed while reference remains**
    
    The Issues table still tells users to authenticate via `gh auth login`, but the FAQ entry that explained how to install and sign in with the GitHub CLI was removed in this PR. New users who aren't familiar with `gh` now have no guidance on how to fulfil that prerequisite. Consider adding a brief inline note (e.g., a parenthetical link to the `gh` install page) or keeping a condensed version of the auth tip.
    
    How can I resolve this? If you propose a fix, please make it concise.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix All With AI
This is a comment left during a code review.
Path: README.md
Line: 56

Comment:
**Screenshot still served from a beta-labelled path**

The image URL `https://emdash.sh/media/blog/public-v1-beta/v1beta.jpg` lives under a `public-v1-beta` directory and is named `v1beta.jpg`. While the PR description notes this is intentional, any visitor who inspects the URL (or any broken-image fallback) will see "v1beta", which subtly contradicts the "Stable v1 is now available" copy directly above it. Consider hosting a stable-launch screenshot at a path like `media/readme/v1.jpg` to keep messaging consistent.

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: README.md
Line: 118

Comment:
**GitHub CLI setup context removed while reference remains**

The Issues table still tells users to authenticate via `gh auth login`, but the FAQ entry that explained how to install and sign in with the GitHub CLI was removed in this PR. New users who aren't familiar with `gh` now have no guidance on how to fulfil that prerequisite. Consider adding a brief inline note (e.g., a parenthetical link to the `gh` install page) or keeping a condensed version of the auth tip.

How can I resolve this? If you propose a fix, please make it concise.

Reviews (1): Last reviewed commit: "Update README for v1 stable launch" | Re-trigger Greptile

Comment thread README.md
</div>

<img alt="Emdash product" src="https://emdash.sh/media/readme/product.jpeg" />
<img alt="Emdash product" src="https://emdash.sh/media/blog/public-v1-beta/v1beta.jpg" />
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Screenshot still served from a beta-labelled path

The image URL https://emdash.sh/media/blog/public-v1-beta/v1beta.jpg lives under a public-v1-beta directory and is named v1beta.jpg. While the PR description notes this is intentional, any visitor who inspects the URL (or any broken-image fallback) will see "v1beta", which subtly contradicts the "Stable v1 is now available" copy directly above it. Consider hosting a stable-launch screenshot at a path like media/readme/v1.jpg to keep messaging consistent.

Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 56

Comment:
**Screenshot still served from a beta-labelled path**

The image URL `https://emdash.sh/media/blog/public-v1-beta/v1beta.jpg` lives under a `public-v1-beta` directory and is named `v1beta.jpg`. While the PR description notes this is intentional, any visitor who inspects the URL (or any broken-image fallback) will see "v1beta", which subtly contradicts the "Stable v1 is now available" copy directly above it. Consider hosting a stable-launch screenshot at a path like `media/readme/v1.jpg` to keep messaging consistent.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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