@@ -15,23 +15,54 @@ 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: Download prebuilt binary (recommended)
21+
22+ No Go or compiler needed.
23+
24+ 1 . Download the latest release for your platform:
2125
2226→ [ GitHub Releases] ( https://github.com/tduyng/codeme/releases/latest )
2327
24- Pick the one for your platform, extract it, and put it somewhere on your ` PATH ` .
28+ | Your OS | Download this file |
29+ | -------------- | -------------------------------------- |
30+ | macOS (Apple) | ` codeme_<version>_darwin_arm64.tar.gz ` |
31+ | macOS (Intel) | ` codeme_<version>_darwin_amd64.tar.gz ` |
32+ | Linux (x86_64) | ` codeme_<version>_linux_amd64.tar.gz ` |
33+ | Linux (ARM64) | ` codeme_<version>_linux_arm64.tar.gz ` |
2534
26- ** Or install with Go ** (requires [ Go 1.25+ ] ( https://go.dev/dl/ ) and a C compiler) :
35+ 2 . Extract the archive :
2736
2837``` bash
29- go install github.com/tduyng/codeme@latest
38+ tar -xzf codeme_< version> _< platform> .tar.gz
39+ ```
40+
41+ 3 . Move the binary to a directory in your PATH:
42+
43+ ``` bash
44+ # Option A: User local bin (recommended)
45+ mv codeme ~ /.local/bin/codeme
46+
47+ # Option B: System-wide (requires sudo)
48+ sudo mv codeme /usr/local/bin/codeme
49+ ```
50+
51+ 4 . Verify it works:
52+
53+ ``` bash
54+ codeme stats
3055```
3156
32- > See the [ codeme backend repo] ( https://github.com/tduyng/codeme ) for full install options and details.
57+ ### Option 2: Install with Go
58+
59+ Requires [ Go 1.25+] ( https://go.dev/dl/ ) :
60+
61+ ``` bash
62+ go install github.com/tduyng/codeme@latest
63+ ```
3364
34- After install , verify it works :
65+ After installing , verify:
3566
3667``` bash
3768codeme stats
0 commit comments