From 67736487fbcfeb50df8d05726063b03732ee636c Mon Sep 17 00:00:00 2001 From: phernandez Date: Sat, 15 Mar 2025 10:43:41 -0500 Subject: [PATCH] update README.md Signed-off-by: phernandez --- README.md | 14 ++++++++------ docs/Welcome to Basic memory.md | 9 +++++---- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ca6a4181..78023441 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,13 @@ enable any compatible LLM to read and write to your local knowledge base. - Website: http://basicmachines.co - Documentation: http://memory.basicmachines.co -![Deno](docs/attachments/Claude-Obsidian-Demo.mp4) +## Pick up your conversation right where you left off -Basic Memory provides persistent contextual awareness across sessions through a structured knowledge graph. -The system enables LLMs to access and reference prior conversations, track semantic relationships between concepts, and -incorporate human edits made directly to knowledge files. +- AI assistants can load context from local files in a new conversation +- Notes are saved locally as Markdown files in real time +- No project knowledge or special prompting required + +![[Claude-Obsidian-Demo.mp4]] ## Quick Start @@ -74,10 +76,10 @@ You can also install the CLI tools to sync files or manage projects. uv tool install basic-memory # create a new project in a different directory -basic-memory project add coffee ./examples/coffee +uv tool run basic-memory project add coffee ./examples/coffee # you can set the project to the default -basic-memory project default coffee +uv tool run basic-memory project default coffee ``` View available projects diff --git a/docs/Welcome to Basic memory.md b/docs/Welcome to Basic memory.md index a2bfe6d5..124984c7 100644 --- a/docs/Welcome to Basic memory.md +++ b/docs/Welcome to Basic memory.md @@ -21,16 +21,17 @@ Basic Memory connects you and AI assistants through shared knowledge: 3. **Enables knowledge reuse** across different conversations and sessions 4. **Maintains persistence** through local files you control completely -Both you and AI assistants like Claude can read from and write to the same knowledge base, creating a continuous learning environment where each conversation builds upon previous ones. +Both you and AI assistants like Claude can read from and write to the same knowledge base, creating a continuous +learning environment where each conversation builds upon previous ones. -## Pick up your conversation right where you left off - -![[Claude-Obsidian-Demo.mp4]] +## Pick up your conversation right where you left off - AI assistants can load context from local files in a new conversation - Notes are saved locally as Markdown files in real time - No project knowledge or special prompting required +![[Claude-Obsidian-Demo.mp4]] + Basic Memory uses: - **Files as the source of truth** - Everything is stored in plain Markdown files