Skip to content

docs: brew relink step after in-app update to v0.6.0 #9

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
anbturki merged 1 commit into from
Jul 3, 2026
Merged

docs: brew relink step after in-app update to v0.6.0 #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Cursor (`~/.cursor/mcp.json`) and Windsurf (`~/.codeium/windsurf/mcp_config.json
{ "mcpServers": { "docsreader": { "command": "docsreader-mcp" } } }
```

If `docsreader-mcp` is not on your PATH (macOS DMG install without Homebrew), use the full binary path from the table above instead.
If `docsreader-mcp` is not on your PATH (macOS DMG install without Homebrew), use the full binary path from the table above instead. Homebrew users who installed before v0.6.0 and auto-updated in-app: run `brew upgrade --cask docsreader` once so Homebrew links the binary - the in-app updater cannot do that. The in-app Connect flow always writes the full path, so it works regardless.

Then tell your agents how to use it: copy the [AGENTS template](docs/AGENTS-TEMPLATE.md) into your repo's `AGENTS.md` or `CLAUDE.md`.

Expand Down
2 changes: 2 additions & 0 deletions src-tauri/resources/welcome/Getting started/Connect your AI agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Cursor (`~/.cursor/mcp.json`) and Windsurf (`~/.codeium/windsurf/mcp_config.json

Installed from the macOS DMG without Homebrew? Use the full path instead: `/Applications/DocsReader.app/Contents/MacOS/docsreader-mcp`.

Installed with Homebrew before v0.6.0 and let the app update itself? Homebrew only links `docsreader-mcp` onto your PATH when the cask itself upgrades - run `brew upgrade --cask docsreader` once, or just use the one-click Connect above (it always writes the full path).

## What agents do with it

- **Docs** land in folders that mirror their lifecycle - `research/`, `in-progress/`, `done/`, `archived/`. The folder is the status; moving the file is the status change.
Expand Down
Loading