Skip to content

Commit f923d52

Browse files
committed
docs: clarify README usage and config paths
1 parent 9f7402c commit f923d52

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,19 @@ It adds four tools:
1111

1212
## Why this is useful
1313

14-
This plugin is most helpful when your current session is full and you need to keep moving.
14+
This plugin is most helpful when:
15+
16+
- your current session's context window is full and want to continue in a new session without losing context
17+
- you remember discussing something but forgot the details
18+
- you want OpenCode to recall a decision from a past session
19+
- you need to find where a bug, fix, or plan was originally discussed
1520

1621
Example workflow:
1722

1823
1. Start a new session.
1924
2. Ask OpenCode: "Review our last session and continue from where we left off."
2025
3. It can find and read the previous session, then pick up the work.
2126

22-
It is also useful when:
23-
24-
- you remember discussing something but forgot the details
25-
- you want OpenCode to recall a decision from a past session
26-
- you need to find where a bug, fix, or plan was originally discussed
27-
2827
In practice, it feels like a lightweight memory system built on your own local session history.
2928

3029
## What the tools do
@@ -46,7 +45,7 @@ Optional agent hint: if your agent often misses prior-session context, add this
4645

4746
### From npm (recommended)
4847

49-
Add this to `~/.config/opencode/opencode.jsonc` (or project `opencode.json`):
48+
Add this to `~/.config/opencode/opencode.jsonc` or `~/.config/opencode/opencode.json` (or project `opencode.json`):
5049

5150
```jsonc
5251
{

0 commit comments

Comments
 (0)