@@ -15,23 +15,66 @@ Zero config. 100% private. Auto-adapts to your colorscheme.
1515## Prerequisites
1616
1717codeme.nvim requires the [ codeme binary] ( https://github.com/tduyng/codeme ) (the backend) to be installed on your system.
18- The plugin does not install it automatically, you need to set it up once before first use.
18+ The plugin does not install it automatically — you need to set it up once before first use.
1919
20- ** Easiest way — download a prebuilt binary ** (no Go or compiler needed):
20+ ### Option 1: Homebrew (macOS / Linux)
2121
22- → [ GitHub Releases] ( https://github.com/tduyng/codeme/releases/latest )
22+ ``` bash
23+ brew install tduyng/tap/codeme
24+ ```
25+
26+ Verify:
27+
28+ ``` bash
29+ codeme stats
30+ ```
2331
24- Pick the one for your platform, extract it, and put it somewhere on your ` PATH ` .
32+ ### Option 2: Go install
2533
26- ** Or install with Go ** (requires [ Go 1.25+] ( https://go.dev/dl/ ) and a C compiler ):
34+ Requires [ Go 1.25+] ( https://go.dev/dl/ ) :
2735
2836``` bash
2937go install github.com/tduyng/codeme@latest
3038```
3139
32- > See the [ codeme backend repo] ( https://github.com/tduyng/codeme ) for full install options and details.
40+ Verify:
41+
42+ ``` bash
43+ codeme stats
44+ ```
45+
46+ ### Option 3: Download prebuilt binary
47+
48+ No Go or compiler needed.
49+
50+ 1 . Download the latest release for your platform:
51+
52+ → [ GitHub Releases] ( https://github.com/tduyng/codeme/releases/latest )
53+
54+ | Your OS | Download this file |
55+ | -------------- | -------------------------------------- |
56+ | macOS (Apple) | ` codeme_<version>_darwin_arm64.tar.gz ` |
57+ | macOS (Intel) | ` codeme_<version>_darwin_amd64.tar.gz ` |
58+ | Linux (x86_64) | ` codeme_<version>_linux_amd64.tar.gz ` |
59+ | Linux (ARM64) | ` codeme_<version>_linux_arm64.tar.gz ` |
60+
61+ 2 . Extract the archive:
62+
63+ ``` bash
64+ tar -xzf codeme_< version> _< platform> .tar.gz
65+ ```
66+
67+ 3 . Move the binary to your PATH:
68+
69+ ``` bash
70+ # User local bin (recommended)
71+ mv codeme ~ /.local/bin/codeme
72+
73+ # Or system-wide (requires sudo)
74+ sudo mv codeme /usr/local/bin/codeme
75+ ```
3376
34- After install, verify it works :
77+ 4 . Verify :
3578
3679``` bash
3780codeme stats
0 commit comments