Skip to content

Commit 63ae9ee

Browse files
committed
docs: Re-implement external documentation improvements
- Fix typo: 'enviroment' -> 'environment' in CLAUDE.md - Update HTTP links to HTTPS in README.md - Add comprehensive VS Code integration instructions - Maintain correct internal link references All improvements re-implemented by Basic Machines team for clean IP ownership.
1 parent 0e78751 commit 63ae9ee

2 files changed

Lines changed: 35 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ See the [README.md](README.md) file for a project overview.
6363
- Testing uses pytest with asyncio support (strict mode)
6464
- Test database uses in-memory SQLite
6565
- Avoid creating mocks in tests in most circumstances.
66-
- Each test runs in a standalone enviroment with in memory SQLite and tmp_file directory
66+
- Each test runs in a standalone environment with in memory SQLite and tmp_file directory
6767

6868
## BASIC MEMORY PRODUCT USAGE
6969

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Basic Memory lets you build persistent knowledge through natural conversations w
1313
Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
1414
enable any compatible LLM to read and write to your local knowledge base.
1515

16-
- Website: http://basicmachines.co
17-
- Documentation: http://memory.basicmachines.co
16+
- Website: https://basicmachines.co
17+
- Documentation: https://memory.basicmachines.co
1818

1919
## Pick up your conversation right where you left off
2020

@@ -262,6 +262,38 @@ Examples of relations:
262262
- documented_in [[Coffee Journal]]
263263
```
264264

265+
## Using with VS Code
266+
267+
Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
268+
269+
```json
270+
{
271+
"mcp": {
272+
"servers": {
273+
"basic-memory": {
274+
"command": "uvx",
275+
"args": ["basic-memory", "mcp"]
276+
}
277+
}
278+
}
279+
}
280+
```
281+
282+
Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.
283+
284+
```json
285+
{
286+
"servers": {
287+
"basic-memory": {
288+
"command": "uvx",
289+
"args": ["basic-memory", "mcp"]
290+
}
291+
}
292+
}
293+
```
294+
295+
You can use Basic Memory with VS Code to easily retrieve and store information while coding.
296+
265297
## Using with Claude Desktop
266298

267299
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)