Skip to content

Commit 79bb728

Browse files
committed
chore: update readme
1 parent a9cb981 commit 79bb728

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,17 @@ jobs:
2424

2525
<img width="798" height="184" alt="Screenshot 2025-07-26 at 21 00 22" src="https://github.com/user-attachments/assets/f541c9f7-f778-4d6c-a9f0-d19c8154fc61" />
2626

27-
3. Install [wush](https://github.com/coder/wush) on your local machine, run `wush ssh`, and paste the key.
27+
3. Install [wush](https://github.com/coder/wush?tab=readme-ov-file#install) on your local machine:
28+
29+
```bash
30+
curl -fsSL https://github.com/coder/wush/raw/refs/heads/main/install.sh | sh
31+
```
32+
33+
4. Run `wush ssh`, and paste the key.
2834

2935
<img width="1047" height="284" alt="Screenshot 2025-07-26 at 21 02 39 1" src="https://github.com/user-attachments/assets/0e9a008d-10a2-4ad9-9220-37975021c2e6" />
3036

31-
4. You're in!
37+
5. You're in!
3238

3339
<img width="1046" height="271" alt="Screenshot 2025-07-26 at 21 04 11" src="https://github.com/user-attachments/assets/554eb0d9-4caa-4a3b-80c0-193bc202f2bc" />
3440

@@ -38,11 +44,13 @@ jobs:
3844
- Windows (`x86_64` and `arm64`)
3945
- macOS (`x86_64` and `arm64`)
4046

41-
## Security
47+
## How it works
4248

4349
[Wush](https://github.com/coder/wush) establishes a Wireguard tunnel between your local machine and a GitHub Actions runner - traffic is E2E-encrypted.
4450
It doesn't require you to trust any 3rd party authentication or relay servers, instead using x25519 keys to authenticate connections.
4551

52+
For more information, see [wush's README](https://github.com/coder/wush?tab=readme-ov-file#technical-details) and [source code](https://github.com/coder/wush).
53+
4654
## Usage tips
4755

4856
To run `coder/wush-action` regardless of whether a job succeeds or fails, consider using `${{ !cancelled }}` instead of `${{ always() }}`:

0 commit comments

Comments
 (0)