Skip to content

Commit cf61fe3

Browse files
committed
chore: update README
1 parent ce9595d commit cf61fe3

File tree

2 files changed

+20
-28
lines changed

2 files changed

+20
-28
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@ Track your coding sessions automatically. No account, no cloud, no config, just
66

77
## Install
88

9-
### Download prebuilt binary (recommended)
9+
### Homebrew (macOS / Linux)
10+
11+
```bash
12+
brew install tduyng/tap/codeme
13+
```
14+
15+
### Go install
16+
17+
Requires [Go 1.25+](https://go.dev/dl/):
18+
19+
```bash
20+
go install github.com/tduyng/codeme@latest
21+
```
22+
23+
### Download prebuilt binary
1024

1125
No dependencies needed.
1226

@@ -24,41 +38,26 @@ No dependencies needed.
2438
2. Extract the archive:
2539

2640
```bash
27-
# macOS / Linux
2841
tar -xzf codeme_<version>_<platform>.tar.gz
2942
```
3043

31-
3. Move the binary to a directory in your PATH:
44+
3. Move the binary to your PATH:
3245

3346
```bash
34-
# Option A: User local bin (recommended)
47+
# User local bin (recommended)
3548
mv codeme ~/.local/bin/codeme
3649

37-
# Option B: System-wide (requires sudo)
50+
# Or system-wide (requires sudo)
3851
sudo mv codeme /usr/local/bin/codeme
3952
```
4053

41-
4. Verify it works:
42-
43-
```bash
44-
codeme stats
45-
```
46-
47-
### Go install
48-
49-
Requires [Go 1.25+](https://go.dev/dl/):
50-
51-
```bash
52-
go install github.com/tduyng/codeme@latest
53-
```
54-
5554
### Build from source
5655

57-
Same requirements as above: Go 1.25+. No external dependencies.
56+
Requires Go 1.25+:
5857

5958
```bash
6059
git clone https://github.com/tduyng/codeme
61-
cd codeme && just install # must have justfile installed
60+
cd codeme && just install
6261
```
6362

6463
## Quick Start

justfile

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ coverage:
4646
clean:
4747
@rm -rf dist/ {{ bin_name }} coverage/
4848

49-
changelog:
50-
@echo "→ Generating changelog with git‑cliff…"
51-
@git cliff --latest --prepend {{ changelog }}
52-
@git cliff --latest --strip all --output LATEST_CHANGELOG.md
53-
@echo "Changelog written to {{ changelog }}"
54-
5549
tag VERSION:
5650
@echo "Creating tag v{{ VERSION }}..."
5751
@git checkout main
@@ -61,7 +55,6 @@ tag VERSION:
6155
@echo "→ Generating changelog..."
6256
@git cliff --unreleased --tag "v{{ VERSION }}" --prepend {{ changelog }}
6357
@git cliff --unreleased --tag "v{{ VERSION }}" --strip all > LATEST_CHANGELOG.md
64-
@rm LATEST_CHANGELOG.md # Clean tmp
6558
@git add {{ changelog }} {{ version_file }}
6659
@git commit -m "chore: release v{{ VERSION }}"
6760
@git tag -a v{{ VERSION }} -m "Release v{{ VERSION }}"

0 commit comments

Comments
 (0)