chore: Pre beta prep

README.md

@@ -20,6 +20,14 @@ Basic Memory lets you build persistent knowledge through natural conversations w
 Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
 enable any compatible LLM to read and write to your local knowledge base.
 
+LLMs can build context from local knowledge bases.
+
+![Example Gif](docs/attachments/Obsidian-CoffeeKnowledgeBase-examples-overlays.gif)
+
+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.
+
 ## Quick Start
 
 ```bash
@@ -39,18 +47,43 @@ uv install basic-memory
     }
   }
 }
-
-# Start real-time sync
-basic-memory sync --watch
-
 # Now in Claude Desktop, you can:
 # - Write notes with "Create a note about coffee brewing methods"
 # - Read notes with "What do I know about pour over coffee?"
 # - Search with "Find information about Ethiopian beans"
 
-# View files shared context via files in ~/basic-memory 
 ```
 
+You can view shared context via files in `~/basic-memory` (default directory location).
+
+You can also install the cli tools to sync files or manage projects.
+
+```bash 
+uv tool install basic-memory
+
+# create a new project in a different directory
+basic-memory project add coffee ./examples/coffee
+
+# you can set the project to the default 
+basic-memory project default coffee
+```
+
+View available projects
+
+```bash 
+basic-memory project list
+                             Basic Memory Projects
+┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┓
+┃ Name   ┃ Path                                             ┃ Default ┃ Active ┃
+┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━┩
+│ main   │ ~/basic-memory                                   │ ✓       │ ✓      │
+│ coffee │ ~/dev/basicmachines/basic-memory/examples/coffee │         │        │
+└────────┴──────────────────────────────────────────────────┴─────────┴────────┘
+```
+
+Basic Memory will write notes in Markdown format. Open you project directory in your text editor to view project files
+while you have conversations with an LLM.
+
 ## Why Basic Memory?
 
 Most LLM interactions are ephemeral - you ask a question, get an answer, and everything is forgotten. Each conversation
@@ -61,7 +94,8 @@ starts fresh, without the context or knowledge from previous ones. Current worka
 - Vector databases require complex setups and often live in the cloud
 - Knowledge graphs typically need specialized tools to maintain
 
-Basic Memory solves these problems with a simple approach: structured Markdown files that both humans and LLMs can read
+Basic Memory addresses these problems with a simple approach: structured Markdown files that both humans and LLMs can
+read
 and write to. The key advantages:
 
 - **Local-first:** All knowledge stays in files you control

docs/.obsidian/app.json

@@ -0,0 +1 @@
+{}

docs/.obsidian/appearance.json

@@ -0,0 +1 @@
+{}

docs/.obsidian/core-plugins.json

@@ -0,0 +1,31 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "properties": false,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": true,
+  "sync": true,
+  "webviewer": false
+}

docs/.obsidian/publish.json

@@ -0,0 +1,6 @@
+{
+  "siteId": "947ee055a8c6f1a57efa4afa09791e62",
+  "host": "publish-01.obsidian.md",
+  "included": [],
+  "excluded": []
+}

docs/.obsidian/workspace.json

@@ -0,0 +1,167 @@
+{
+  "main": {
+    "id": "9361625269255fc5",
+    "type": "split",
+    "children": [
+      {
+        "id": "9220768da355d9a9",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "cd58e5dfc86465e3",
+            "type": "leaf",
+            "state": {
+              "type": "empty",
+              "state": {},
+              "icon": "lucide-file",
+              "title": "New tab"
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "vertical"
+  },
+  "left": {
+    "id": "932aa23fccfbb069",
+    "type": "split",
+    "children": [
+      {
+        "id": "c60acde475f2bc34",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "a06f3217ff27ae41",
+            "type": "leaf",
+            "state": {
+              "type": "file-explorer",
+              "state": {
+                "sortOrder": "alphabetical",
+                "autoReveal": false
+              },
+              "icon": "lucide-folder-closed",
+              "title": "Files"
+            }
+          },
+          {
+            "id": "c338fa22e7339c9a",
+            "type": "leaf",
+            "state": {
+              "type": "search",
+              "state": {
+                "query": "",
+                "matchingCase": false,
+                "explainSearch": false,
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical"
+              },
+              "icon": "lucide-search",
+              "title": "Search"
+            }
+          },
+          {
+            "id": "56de0827023b2535",
+            "type": "leaf",
+            "state": {
+              "type": "bookmarks",
+              "state": {},
+              "icon": "lucide-bookmark",
+              "title": "Bookmarks"
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300
+  },
+  "right": {
+    "id": "c3389d21c08cd71c",
+    "type": "split",
+    "children": [
+      {
+        "id": "11a1174f51a1cf86",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "bf2a1fb608e63866",
+            "type": "leaf",
+            "state": {
+              "type": "backlink",
+              "state": {
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical",
+                "showSearch": false,
+                "searchQuery": "",
+                "backlinkCollapsed": false,
+                "unlinkedCollapsed": true
+              },
+              "icon": "links-coming-in",
+              "title": "Backlinks"
+            }
+          },
+          {
+            "id": "6f08673b57226dc1",
+            "type": "leaf",
+            "state": {
+              "type": "outgoing-link",
+              "state": {
+                "linksCollapsed": false,
+                "unlinkedCollapsed": true
+              },
+              "icon": "links-going-out",
+              "title": "Outgoing links"
+            }
+          },
+          {
+            "id": "e987a9643ca3ec81",
+            "type": "leaf",
+            "state": {
+              "type": "tag",
+              "state": {
+                "sortOrder": "frequency",
+                "useHierarchy": true,
+                "showSearch": false,
+                "searchQuery": ""
+              },
+              "icon": "lucide-tags",
+              "title": "Tags"
+            }
+          },
+          {
+            "id": "108a72a022d7e501",
+            "type": "leaf",
+            "state": {
+              "type": "outline",
+              "state": {
+                "followCursor": false,
+                "showSearch": false,
+                "searchQuery": ""
+              },
+              "icon": "lucide-list",
+              "title": "Outline"
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300,
+    "collapsed": true
+  },
+  "left-ribbon": {
+    "hiddenItems": {
+      "publish:Publish changes...": false,
+      "switcher:Open quick switcher": false,
+      "graph:Open graph view": false,
+      "canvas:Create new canvas": false,
+      "daily-notes:Open today's daily note": false,
+      "templates:Insert template": false,
+      "command-palette:Open command palette": false
+    }
+  },
+  "active": "a06f3217ff27ae41",
+  "lastOpenFiles": []
+}