Skip to content

Update README for v1 stable launch #1759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rabanspiegel wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −44
Open

Update README for v1 stable launch #1759

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 8 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@

<br />

<a href="https://github.com/generalaction/emdash/releases" style="display:inline-block; margin-right:8px; text-decoration:none; outline:none; border:none;">
<a href="https://emdash.sh/download" style="display:inline-block; margin-right:8px; text-decoration:none; outline:none; border:none;">
<img src="https://emdash.sh/media/readme/downloadforwindows.png" alt="Download for Windows" height="40">
</a>
<a href="https://github.com/generalaction/emdash/releases" style="display:inline-block; margin-right:8px; text-decoration:none; outline:none; border:none;">
<a href="https://emdash.sh/download" style="display:inline-block; margin-right:8px; text-decoration:none; outline:none; border:none;">
<img src="https://emdash.sh/media/readme/downloadformacos.png" alt="Download for macOS" height="40">
</a>
<a href="https://github.com/generalaction/emdash/releases" style="display:inline-block; text-decoration:none; outline:none; border:none;">
<a href="https://emdash.sh/download" style="display:inline-block; text-decoration:none; outline:none; border:none;">
<img src="https://emdash.sh/media/readme/downloadforlinux.png" alt="Download for Linux" height="40">
</a>

<h3>
<a href="https://www.emdash.sh/download">Download the Emdash v1 beta</a>
<a href="https://emdash.sh/download">Download Emdash v1</a>
</h3>
<p>
Now available for macOS, Windows, and Linux ·
<a href="https://www.emdash.sh/blog/public-v1-beta">Read the launch post</a>
Stable v1 is now available for macOS, Windows, and Linux ·
<a href="https://emdash.sh/blog/emdash-v1-stable">Read the launch post</a>
</p>

</div>
Expand All @@ -53,17 +53,14 @@ Connect to remote machines via SSH/SFTP to work with remote codebases. Emdash su

</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

@greptile-apps greptile-apps Bot Apr 24, 2026

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!


# Installation

### macOS
- Apple Silicon: https://github.com/generalaction/emdash/releases/latest/download/emdash-arm64.dmg
- Intel x64: https://github.com/generalaction/emdash/releases/latest/download/emdash-x64.dmg

[![Homebrew](https://img.shields.io/badge/-Homebrew-000000?style=for-the-badge&logo=homebrew&logoColor=FBB040)](https://formulae.brew.sh/cask/emdash)
> macOS users can also: `brew install --cask emdash`

### Windows
- Installer (x64): https://github.com/generalaction/emdash/releases/latest/download/emdash-x64.msi
- Portable (x64): https://github.com/generalaction/emdash/releases/latest/download/emdash-x64.exe
Expand Down Expand Up @@ -160,51 +157,18 @@ Contributions welcome! See the [Contributing Guide](CONTRIBUTING.md) to get star
> You can reset the local DB by deleting it (quit the app first). The file is recreated on next launch.
</details>

<details>
<summary><b>Do I need GitHub CLI?</b></summary>

> **Only if you want GitHub features** (open PRs from Emdash, fetch repo info, GitHub Issues integration).
> Install & sign in:
>
> ```bash
> gh auth login
> ```
>
> If you don’t use GitHub features, you can skip installing `gh`.
</details>

<details>
<summary><b>How do I add a new provider?</b></summary>

> Emdash is **provider‑agnostic** and built to add CLIs quickly.
>
> - Open a PR following the **Contributing Guide** (`CONTRIBUTING.md`).
> - Include: provider name, how it’s invoked (CLI command), auth notes, and minimal setup steps.
> - We’ll add it to the **Integrations** matrix and wire up provider selection in the UI.
> - We’ll add it to the **Providers table** and wire up provider selection in the UI.
>
> If you’re unsure where to start, open an issue with the CLI’s link and typical commands.
</details>

<details>
<summary><b>I hit a native‑module crash (sqlite3 / node‑pty / keytar). What’s the fast fix?</b></summary>

> This usually happens after switching Node/Electron versions.
>
> 1) Rebuild native modules:
>
> ```bash
> npm run rebuild
> ```
>
> 2) If that fails, clean and reinstall:
>
> ```bash
> npm run reset
> ```
>
> (Resets `node_modules`, reinstalls, and re‑builds Electron native deps.)
</details>

<details>
<summary><b>What permissions does Emdash need?</b></summary>

Expand Down
Loading