Skip to content

docs: update README for HTTPS, TLS, and service management#26

Merged
aniongithub merged 6 commits into
mainfrom
docs/readme-update
May 10, 2026
Merged

docs: update README for HTTPS, TLS, and service management#26
aniongithub merged 6 commits into
mainfrom
docs/readme-update

Conversation

@aniongithub
Copy link
Copy Markdown
Owner

Updates the README to reflect all the recent changes and match the polish level of devcontainer-mcp's README.

Added:

  • Website badge linking to gh-pages site
  • Hero GIF (mind-map-save-edit-retrieve.gif)
  • "Works with" line (GitHub Copilot, Claude, Cursor)
  • Installer details section (hosts file, TLS setup, service install)
  • Service Management section with CLI examples
  • TLS Setup section with manual cert management commands

Updated:

  • HTTP → HTTPS throughout (server, architecture diagram, URLs)
  • Default port 80 → 443
  • Two Modes table: HTTP → HTTPS, shows https://mind-map.local
  • MCP tools count: 8 → 9 (register_sync was listed separately)
  • Architecture diagram: HTTP Server → HTTPS Server
  • CI/CD platforms: 4 → 6
  • Dashes standardized: --

- Add website badge and hero GIF (mind-map-save-edit-retrieve.gif)
- Add 'Works with' line (Copilot, Claude, Cursor)
- Update HTTP → HTTPS throughout
- Update default port references (443)
- Add installer details (hosts file, TLS, service setup)
- Add Service Management section
- Add TLS Setup section
- Fix MCP tools count (8 → 9, register_sync was listed separately)
- Update architecture diagram (HTTP Server → HTTPS Server)
- Update Two Modes table (HTTP → HTTPS)
- Fix CI/CD platforms count (4 → 6)
- Standardize dashes (-- → —)
References Karpathy's LLM Knowledge Base pattern. Highlights
SQLite FTS5 as production-grade search vs hand-rolled scripts,
server-first architecture vs desktop apps, and plain markdown
portability.
Merge The Problem, The Solution, and Why a wiki? into a single
compact section with a two-column table. Moves it before the
code example for better flow.
@aniongithub aniongithub merged commit 3582f8f into main May 10, 2026
1 check passed
@aniongithub aniongithub deleted the docs/readme-update branch May 10, 2026 17:23
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.

1 participant