Skip to content

Commit 96faafe

Browse files
committed
docs: improve installation & quick start for easier onboarding
- Reordered Installation section so "Download Pre-built Binary" comes first (easiest path) - Made "Build from Source" the recommended method for v0.1.0 with clearer instructions - Updated the 60-Second Quick Start to lead with `git clone + make build` instead of the currently broken `go install` - Improved step descriptions and reduced friction for first-time users - Made the Go Install note clearer about the current limitation and future plans
1 parent c546cbb commit 96faafe

1 file changed

Lines changed: 24 additions & 18 deletions

File tree

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,25 @@ It’s the most reliable way today to bring your local clipboard into remote dev
2828

2929
## 60-Second Quick Start
3030

31+
The easiest way to get started:
32+
3133
```bash
32-
# 1. Install the CLI (recommended)
33-
go install github.com/Zen-Open-Source/PasteLocal/cmd/pastelocal@latest
34+
# 1. Build from source (most reliable method for v0.1.0)
35+
git clone https://github.com/Zen-Open-Source/PasteLocal.git
36+
cd PasteLocal
37+
make build
3438

35-
# 2. Set up the local daemon and generate a secure token
36-
pastelocal init
39+
# 2. Initialize the local daemon
40+
./bin/pastelocal init
3741

38-
# 3. Add your remote server (this edits your SSH config and installs the remote helper)
39-
pastelocal add-host myserver
42+
# 3. Add your remote host (automatically sets up SSH forwarding)
43+
./bin/pastelocal add-host myserver
4044

41-
# 4. SSH into the server and pull your local clipboard
42-
pastelocal-remote
45+
# 4. On the remote server, pull your local clipboard
46+
./bin/pastelocal-remote
4347
```
4448

45-
`pastelocal-remote` will save the latest clipboard content (including screenshots) to a file on the remote machine and print the path.
46-
47-
You can then use the `/paste` skill (or just read the file) inside your agentic coding tool.
49+
`pastelocal-remote` will save your latest clipboard content (including screenshots) to a file on the remote machine and print the path. You can then read it with your agentic coding tool.
4850

4951
---
5052

@@ -74,23 +76,27 @@ You can then use the `/paste` skill (or just read the file) inside your agentic
7476

7577
## Installation
7678

77-
### Recommended: Go Install
79+
### Download Pre-built Binary (Easiest)
7880

79-
```bash
80-
go install github.com/Zen-Open-Source/PasteLocal/cmd/pastelocal@latest
81-
```
81+
Download the latest release for your platform from the [Releases page](https://github.com/Zen-Open-Source/PasteLocal/releases).
8282

83-
### Build from Source
83+
### Build from Source (Recommended)
8484

8585
```bash
8686
git clone https://github.com/Zen-Open-Source/PasteLocal.git
8787
cd PasteLocal
8888
make build
8989
```
9090

91-
Binaries will be in the `bin/` directory.
91+
The binaries will be in the `bin/` directory.
92+
93+
### Go Install
94+
95+
```bash
96+
go install github.com/Zen-Open-Source/PasteLocal/cmd/pastelocal@latest
97+
```
9298

93-
> **Note for v0.1.0:** The recommended `go install` command above may not work yet because the Go module path is still being migrated. For the most reliable experience, we recommend cloning the repo and running `make build` instead.
99+
> **Note:** Due to a pending module path update, `go install` may not work reliably yet. We plan to support it properly in a future release. For now, downloading a release or building from source is recommended.
94100
95101
---
96102

0 commit comments

Comments
 (0)