Skip to content

Commit 9af913d

Browse files
authored
docs: add glama badge. Fix typos in README.md (#28)
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 7b7bec9 commit 9af913d

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 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:
@@ -50,13 +56,15 @@ You can view shared context via files in `~/basic-memory` (default directory loc
5056

5157
### Alternative Installation via Smithery
5258

53-
You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic Memory for Claude Desktop:
59+
You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic
60+
Memory for Claude Desktop:
5461

5562
```bash
5663
npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude
5764
```
5865

59-
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
66+
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The
67+
Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
6068

6169
### CLI Tools
6270

@@ -85,7 +93,7 @@ basic-memory project list
8593
└────────┴──────────────────────────────────────────────────┴─────────┴────────┘
8694
```
8795

88-
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
8997
while you have conversations with an LLM.
9098

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

222-
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:
223231

224232
- Edit in any text editor
225233
- Version via git
@@ -260,7 +268,7 @@ permalink: <a uri slug>
260268

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

265273
Observation Markdown format:
266274

0 commit comments

Comments
 (0)