Skip to content

Commit fa9175f

Browse files
committed
Remove redundant info in README.md
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 7c787a4 commit fa9175f

File tree

1 file changed

+11
-100
lines changed

1 file changed

+11
-100
lines changed

README.md

Lines changed: 11 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -147,36 +147,15 @@ tags:
147147
- affects [[Flavor Extraction]]
148148
```
149149

150-
The note embeds semantic content and links to other topics via simple Markdown
151-
formatting.
150+
The note embeds semantic content and links to other topics via simple Markdown formatting.
152151

153-
3. You see this file on your computer in real time in the `~/$HOME/basic-memory` directory:
152+
3. You see this file on your computer in real time in the current project directory (default `~/$HOME/basic-memory`).
154153

155-
```markdown
156-
---
157-
title: Coffee Brewing Methods
158-
permalink: coffee-brewing-methods
159-
type: note
160-
---
161-
162-
# Coffee Brewing Methods
163-
164-
## Observations
165-
166-
- [method] Pour over provides more clarity and highlights subtle flavors
167-
- [technique] Water temperature at 205°F (96°C) extracts optimal compounds
168-
- [principle] Freshly ground beans preserve aromatics and flavor
169-
- [preference] Medium-light roasts work best for pour over # Added by you
170-
171-
## Relations
154+
- Realtime sync can be enabled via running `basic-memory sync --watch`
172155

173-
- relates_to [[Coffee Bean Origins]]
174-
- requires [[Proper Grinding Technique]]
175-
- affects [[Flavor Extraction]]
176-
- pairs_with [[Breakfast Pastries]] # Added by you
177-
```
156+
4. MCP-compatible LLMs can access this knowledge.
178157

179-
4. In a new chat with the LLM, you can reference this knowledge:
158+
5. In a new chat with the LLM, you can reference a topic:
180159

181160
```
182161
Look at `coffee-brewing-methods` for context about pour over coffee
@@ -196,15 +175,14 @@ Following relation 'requires [[Proper Grinding Technique]]':
196175
- Impact of consistent particle size on extraction
197176
```
198177

199-
Each related document can lead to more context, building a rich semantic understanding of your knowledge base. All of
200-
this context comes from standard Markdown files that both humans and LLMs can read and write.
178+
Each related document can lead to more context, building a rich semantic understanding of your knowledge base.
201179

202-
Every time the LLM writes notes, they are saved in local Markdown files that you can:
180+
This creates a two-way flow where:
203181

204-
- Edit in any text editor
205-
- Version via git
206-
- Back up normally
207-
- Share when you want to
182+
- Humans write and edit Markdown files
183+
- LLMs read and write through the MCP protocol
184+
- Sync keeps everything consistent
185+
- All knowledge stays in local files.
208186

209187
## Technical Implementation
210188

@@ -284,73 +262,6 @@ Examples of relations:
284262
- documented_in [[Coffee Journal]]
285263
```
286264

287-
### Complete Example
288-
289-
Here's a complete example of a note with frontmatter, observations, and relations:
290-
291-
```markdown
292-
---
293-
title: Pour Over Coffee Method
294-
type: note
295-
permalink: pour-over-coffee-method
296-
tags:
297-
- brewing
298-
- coffee
299-
- techniques
300-
---
301-
302-
# Pour Over Coffee Method
303-
304-
This note documents the pour over brewing method and my experiences with it.
305-
306-
## Overview
307-
308-
The pour over method involves pouring hot water through coffee grounds in a filter. The water drains through the coffee
309-
and filter into a carafe or cup.
310-
311-
## Observations
312-
313-
- [equipment] Hario V60 dripper produces clean, bright cup #gear
314-
- [technique] Pour in concentric circles to ensure even extraction
315-
- [ratio] 1:16 coffee-to-water ratio works best for balanced flavor
316-
- [timing] Total brew time should be 2:30-3:00 minutes for medium roast
317-
- [temperature] Water at 205°F (96°C) extracts optimal flavor compounds
318-
- [grind] Medium-fine grind similar to table salt texture
319-
- [tip] 30-45 second bloom with double the coffee weight in water
320-
- [result] Produces a cleaner cup with more distinct flavor notes than immersion methods
321-
322-
## Relations
323-
324-
- complements [[Light Roast Beans]]
325-
- requires [[Gooseneck Kettle]]
326-
- contrasts_with [[French Press Method]]
327-
- pairs_with [[Breakfast Pastries]]
328-
- documented_in [[Brewing Journal]]
329-
- inspired_by [[Japanese Brewing Techniques]]
330-
- affects [[Flavor Extraction]]
331-
- part_of [[Morning Ritual]]
332-
```
333-
334-
Basic Memory will parse the Markdown and derive the semantic relationships in the content. When you run
335-
`basic-memory sync`:
336-
337-
1. New and changed files are detected
338-
2. Markdown patterns become semantic knowledge:
339-
340-
- `[tech]` becomes a categorized observation
341-
- `[[WikiLink]]` creates a relation in the knowledge graph
342-
- Tags and metadata are indexed for search
343-
344-
3. A SQLite database maintains these relationships for fast querying
345-
4. MCP-compatible LLMs can access this knowledge via memory:// URLs
346-
347-
This creates a two-way flow where:
348-
349-
- Humans write and edit Markdown files
350-
- LLMs read and write through the MCP protocol
351-
- Sync keeps everything consistent
352-
- All knowledge stays in local files.
353-
354265
## Using with Claude Desktop
355266

356267
Basic Memory is built using the MCP (Model Context Protocol) and works with the Claude desktop app (https://claude.ai/):

0 commit comments

Comments
 (0)