Skip to content

Commit 68c9d18

Browse files
committed
chore: README example
1 parent 18741e6 commit 68c9d18

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# motivation
1+
# dotllm
2+
```bash
3+
> tree .llm/reference/
4+
.llm/reference/
5+
├── cloudflare-docs -> /home/spader/.local/share/dotllm/store/cloudflare-docs
6+
├── cuda-toolkit -> /home/spader/.local/share/dotllm/store/cuda-toolkit
7+
├── ghostty -> /home/spader/.local/share/dotllm/store/ghostty
8+
├── node-llama-cpp -> /home/spader/.local/share/dotllm/store/node-llama-cpp
9+
├── opencode -> /home/spader/.local/share/dotllm/store/opencode
10+
└── sprites-docs -> /home/spader/.local/share/dotllm/store/sprites-docs
11+
```
12+
213
LLMs work best with references. If you're like me, every project has loose repositories lying around half a dozen places because some LLM needed it.
314

415
Instead, keep a cache of such repositories and use `dotllm` to link them to `.llm`. Check in `.llm/dotllm.json`, and a simple `dotllm sync` will restore all of your references.
@@ -9,7 +20,7 @@ bun install -g @spader/dotllm
920
```
1021

1122
# usage
12-
Register a repository (by HTTPS, SSH, or path)
23+
Register a repository (by HTTPS, SSH, or local path)
1324
```bash
1425
dotllm add https://github.com/tspader/dotllm.git
1526
```

0 commit comments

Comments
 (0)