Skip to content

Commit 2ac620f

Browse files
committed
Merge branch 'main' of github.com:basicmachines-co/basic-memory
2 parents 4cbda7a + 3070ade commit 2ac620f

2 files changed

Lines changed: 24 additions & 6 deletions

File tree

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"
12+

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
# Basic Memory
2-
31
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
42
[![PyPI version](https://badge.fury.io/py/basic-memory.svg)](https://badge.fury.io/py/basic-memory)
53
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
64
[![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
75
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
86
[![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
97

8+
## Glama.ai
9+
10+
<a href="https://glama.ai/mcp/servers/o90kttu9ym">
11+
<img width="380" height="200" src="https://glama.ai/mcp/servers/o90kttu9ym/badge" alt="basic-memory MCP server" />
12+
</a>
13+
14+
# Basic Memory
15+
1016
Basic Memory lets you build persistent knowledge through natural conversations with Large Language Models (LLMs) like
1117
Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
1218
enable any compatible LLM to read and write to your local knowledge base.
@@ -24,7 +30,7 @@ incorporate human edits made directly to knowledge files.
2430

2531
```bash
2632
# Install with uv (recommended)
27-
uv install basic-memory
33+
uv tool install basic-memory
2834

2935
# Configure Claude Desktop (edit ~/Library/Application Support/Claude/claude_desktop_config.json)
3036
# Add this to your config:
@@ -87,7 +93,7 @@ basic-memory project list
8793
└────────┴──────────────────────────────────────────────────┴─────────┴────────┘
8894
```
8995

90-
Basic Memory will write notes in Markdown format. Open you project directory in your text editor to view project files
96+
Basic Memory will write notes in Markdown format. Open your project directory in your text editor to view project files
9197
while you have conversations with an LLM.
9298

9399
## Why Basic Memory?
@@ -221,7 +227,7 @@ Following relation 'requires [[Proper Grinding Technique]]':
221227
Each related document can lead to more context, building a rich semantic understanding of your knowledge base. All of
222228
this context comes from standard Markdown files that both humans and LLMs can read and write.
223229

224-
Every time the LLM writes notes,they are saved in local Markdown files that you can:
230+
Every time the LLM writes notes, they are saved in local Markdown files that you can:
225231

226232
- Edit in any text editor
227233
- Version via git
@@ -262,7 +268,7 @@ permalink: <a uri slug>
262268

263269
Observations are facts about a topic.
264270
They can be added by creating a Markdown list with a special format that can reference a `category`, `tags` using a
265-
"#" charactor, and an optional `context`.
271+
"#" character, and an optional `context`.
266272

267273
Observation Markdown format:
268274

0 commit comments

Comments
 (0)