Skip to content

Improve README & misc small fixes#6

Merged
dvcrn merged 4 commits into
dvcrn:mainfrom
deadmanoz:feature/improve-readme-documentation
Sep 9, 2025
Merged

Improve README & misc small fixes#6
dvcrn merged 4 commits into
dvcrn:mainfrom
deadmanoz:feature/improve-readme-documentation

Conversation

@deadmanoz
Copy link
Copy Markdown
Contributor

Pretty self explanatory changes. Mostly related to the README.

I added .roo and .claude to the .gitignore because I don't believe they should be there :) And I removed these files with git rm --cached - we want them to exist but not be committed to the repo?!?!

Note that I have personally followed Option 3, and got the tool working with Claude Desktop and Claude Code. I have not tested Options 1 and 2, but they look to be correct.

BTW I noticed that the package-lock.json is still referring to version 1.3.0 yet project has been bumped to 1.4.0. I opted not to do anything about that in this PR!

This tool is seriously a game changer for me

Remove developer-specific configuration files that shouldn't be tracked:
- .claude/settings.local.json (local IDE permissions)
- .roo/mcp.json (old project configuration)

Update .gitignore to prevent these directories from being tracked in future.
Standardize project name formatting across all files:
- README.md: Fix title "Devonthink" → "DEVONthink" (proper capitalization)
- justfile: Update project name "MicroFn" → "DEVONthink" (correct project)
- getOpenDatabases.ts: Fix typo "Claude Codet" → "Claude Code"

Ensures consistent branding throughout the codebase.
…perience

- Add complete prerequisites section (macOS, DEVONthink Pro, Node.js, Claude)
- Add three installation options (npm global, npx, local development)
- Add Claude Desktop configuration section with file location and all config options
- Add comprehensive Claude Code section with CLI setup and scope configuration
- Add detailed troubleshooting including real-world issues (tsc not found, restart requirements)
- Fix dependency installation documentation to prevent TypeScript build errors
- Improve verification and testing instructions for both Claude Desktop and Code
@deadmanoz deadmanoz force-pushed the feature/improve-readme-documentation branch from fd573f3 to a9b0163 Compare August 19, 2025 12:56
Comment thread README.md Outdated
@dvcrn dvcrn merged commit 9fd3dd7 into dvcrn:main Sep 9, 2025
@deadmanoz deadmanoz deleted the feature/improve-readme-documentation branch September 10, 2025 03:58
@dvcrn
Copy link
Copy Markdown
Owner

dvcrn commented Sep 10, 2025

ebowman pushed a commit to ebowman/mcp-server-devonthink that referenced this pull request Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants