Skip to content

Commit 2862fc8

Browse files
committed
docs: improve README with cleaner structure and simpler commands
1 parent 6b84ac0 commit 2862fc8

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ One file. Claude remembers everything.
4848

4949
## Installation
5050

51+
```bash
52+
# One-time setup (if you haven't used GitHub plugins before)
53+
git config --global url."https://github.com/".insteadOf "git@github.com:"
54+
```
55+
5156
```bash
5257
# In Claude Code
5358
/plugin add marketplace memvid/claude-brain
@@ -64,10 +69,12 @@ Done.
6469
After install, Claude's memory lives in one file:
6570

6671
```
67-
your-project/.claude/mind.mv2
72+
your-project/
73+
└── .claude/
74+
└── mind.mv2 # Claude's brain. That's it.
6875
```
6976

70-
That's it. No database. No cloud. No API keys.
77+
No database. No cloud. No API keys.
7178

7279
**What gets captured:**
7380
- Session context, decisions, bugs, solutions
@@ -85,12 +92,14 @@ That's it. No database. No cloud. No API keys.
8592

8693
**In Claude Code:**
8794
```bash
88-
/mind:mind search "auth bug" # find past context
89-
/mind:mind ask "why JWT?" # query memory
90-
/mind:mind recent # latest memories
91-
/mind:mind stats # usage stats
95+
/mind stats # memory statistics
96+
/mind search "authentication" # find past context
97+
/mind ask "why did we choose X?" # ask your memory
98+
/mind recent # what happened lately
9299
```
93100

101+
Or just ask naturally: *"mind stats"*, *"search my memory for auth bugs"*, etc.
102+
94103
<br />
95104

96105
## CLI (Optional)

0 commit comments

Comments
 (0)