diff --git a/README.md b/README.md index b839cd0d..cc9b15aa 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/) [![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions) [![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) +[![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory) Basic Memory lets you build persistent knowledge through natural conversations with Large Language Models (LLMs) like Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to @@ -21,6 +22,15 @@ incorporate human edits made directly to knowledge files. ## Quick Start +### Installing via Smithery + +To install Basic Memory for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory): + +```bash +npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude +``` + +### Installing Manually ```bash # Install with uv (recommended) uv install basic-memory @@ -690,4 +700,4 @@ basic-memory tools write-note --title "Meeting Notes" --folder "meetings" < meet AGPL-3.0 -Built with ♥️ by Basic Machines \ No newline at end of file +Built with ♥️ by Basic Machines