Skip to content

Revise README for tool mentions and installation clarity #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aniongithub merged 2 commits into from
May 10, 2026
Merged

Revise README for tool mentions and installation clarity #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc79e05
Revise README for tool mentions and installation clarity
aniongithub May 10, 2026
b5e3eeb
docs: note that MCP config is auto-installed
aniongithub May 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

## Why a wiki?

The idea of [LLM-maintained knowledge bases](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) — where AI agents build and curate a persistent wiki rather than re-discovering answers via RAG — has been gaining traction. Tools like Obsidian are built with the user in mind, not the agent. `mind-map` puts the agent and the human on equal ground.
The idea of [LLM-maintained knowledge bases](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) — where AI agents build and curate a persistent wiki rather than re-discovering answers via RAG — has been gaining traction. Tools like Obsidian or Tolaria are built with the user in mind, not the agent. `mind-map` puts the agent and the human on equal ground.

| The problem | The solution |
|---|---|
Expand All @@ -34,7 +34,7 @@ Agent: "What do we know about authentication?"

## Quick Install

Unlike other wiki knowledge bases, you don't need a tutorial, system dependencies, or RAM-guzzling UIs. One command installs everything, ready for you or your agents to use. No tutorials, no bloat. Zero manual setup.
Unlike other wiki knowledge bases, you don't need a tutorial, system dependencies, or RAM-guzzling UIs. One command installs everything, ready for you or your agents to use. No tutorials, no bloat. Zero manual setup, all batteries included.

### Linux / macOS

Expand All @@ -52,7 +52,7 @@ The installer:
- Downloads the binary and adds it to PATH
- Adds `127.0.0.1 mind-map.local` to your hosts file
- Generates a local TLS certificate so `https://mind-map.local` works with no browser warnings
- Optionally installs mind-map as a persistent system service
- Installs mind-map as a persistent system service

Binaries available for **linux-x64**, **linux-arm64**, **darwin-x64**, **darwin-arm64**, **windows-x64**, and **windows-arm64**.

Expand Down Expand Up @@ -111,7 +111,7 @@ Both modes use the same wiki engine and the same wiki directory (`~/.mind-map/wi

## Web UI

The built-in web UI is a metro-inspired, chromeless Preact app:
The built-in web UI is a lightning-fast, Metro-inspired, chromeless Preact app:

- Sidebar with page list and search
- Markdown rendering with wikilinks as clickable links
Expand Down Expand Up @@ -155,6 +155,8 @@ On Linux, Chrome uses its own NSS certificate store. The installer handles this

## MCP Client Configuration

The installer automatically configures mind-map for GitHub Copilot, Claude, Cursor, and VS Code, and installs agent skills — so this is usually not needed. If you want to configure a client manually:

```json
{
"mcpServers": {
Expand All @@ -168,7 +170,7 @@ On Linux, Chrome uses its own NSS certificate store. The installer handles this
}
```

That's it. No args needed — stdio mode and `~/.mind-map/wiki` are the defaults. Override the directory with `--dir` if needed.
No args needed — stdio mode and `~/.mind-map/wiki` are the defaults. Override the directory with `--dir` if needed.

## Page Format

Expand Down