@@ -14,10 +14,49 @@ A Neovim plugin for automatic coding activity tracking. Works with the ShellTime
1414- ** Event Debouncing** - Efficient heartbeat batching (30s cooldown per file)
1515- ** Offline Support** - Queues heartbeats when daemon unavailable
1616
17+ ## Prerequisites
18+
19+ ### 1. Install ShellTime CLI
20+
21+ ``` bash
22+ curl -sSL https://shelltime.xyz/i | bash
23+ ```
24+
25+ After installation, reload your shell configuration:
26+ - ** zsh** : ` source ~/.zshrc `
27+ - ** fish** : ` source ~/.config/fish/config.fish `
28+ - ** bash** : ` source ~/.bashrc `
29+
30+ ### 2. Initialize and Authenticate
31+
32+ ``` bash
33+ shelltime init
34+ ```
35+
36+ This will:
37+ - Open your browser to authenticate with your ShellTime account
38+ - Install shell hooks for your shell (zsh/fish/bash)
39+ - Start the ShellTime daemon
40+
41+ ### 3. Enable Code Tracking
42+
43+ Add the following to your ShellTime config (` ~/.shelltime/config.yaml ` ):
44+
45+ ``` yaml
46+ codeTracking :
47+ enabled : true
48+ ` ` `
49+
50+ Or in TOML format (` ~/.shelltime/config.toml`):
51+
52+ ` ` ` toml
53+ [codeTracking]
54+ enabled = true
55+ ` ` `
56+
1757# # Requirements
1858
1959- Neovim >= 0.10.0
20- - ShellTime daemon running (` /tmp/shelltime.sock ` )
2160- Git (optional, for branch tracking)
2261
2362# # Installation
@@ -57,19 +96,11 @@ require("shelltime").setup()
5796
5897# # Quick Start
5998
60- 1 . ** Install the ShellTime daemon** - Make sure the daemon is running and listening on ` /tmp/shelltime.sock `
61-
62- 2 . ** Create config file** at ` ~/.shelltime/config.yaml ` :
63-
64- ``` yaml
65- socketPath : /tmp/shelltime.sock
66- codeTracking :
67- enabled : true
68- ` ` `
99+ 1. **Complete the [Prerequisites](#prerequisites)** - Install CLI, authenticate, and enable code tracking
69100
70- 3 . **Install the plugin** using your preferred plugin manager (see above)
101+ 2 . **Install the plugin** using your preferred plugin manager (see above)
71102
72- 4 . **Start coding** - The plugin automatically tracks your activity!
103+ 3 . **Start coding** - The plugin automatically tracks your activity!
73104
74105# # Configuration
75106
@@ -135,6 +166,7 @@ Each heartbeat includes:
1351661. Check if daemon is running :
136167 ` ` ` bash
137168 ls -la /tmp/shelltime.sock
169+ # If not present, run: shelltime init
138170 ` ` `
139171
1401722. Verify config file exists :
0 commit comments