Skip to content

docs: README and branding refresh — MCP positioning, new screenshots, simplified badges#60

Merged
sparshsam merged 3 commits into
mainfrom
docs/mcp-positioning-refresh
Jun 19, 2026
Merged

docs: README and branding refresh — MCP positioning, new screenshots, simplified badges#60
sparshsam merged 3 commits into
mainfrom
docs/mcp-positioning-refresh

Conversation

@sparshsam

Copy link
Copy Markdown
Owner

Summary

Refreshes the OpenReader README to position the project as a privacy-first PDF platform for humans and AI agents. New messaging, simplified badges, fresh screenshot structure, and MCP section elevated to near the top.

Changes

Branding & Positioning

  • Primary message: "Privacy-first PDF tools for humans and AI agents — entirely local."
  • Three usage modes table (desktop GUI, MCP agent, scripted automation)

MCP Section (moved to top, after installation)

  • Rewritten around outcomes: ask questions, search libraries, compare docs, summarize collections, build pipelines
  • Added ASCII architecture diagram: Agent → MCP Server → Local PDFs
  • Quick setup instructions remain

Badges (6 → 5)

  • Removed: Release build, Security, Download count
  • Kept: Latest Release, AGPLv3, CI, Microsoft Store (placeholder), Windows

Screenshots

  • New directory: assets/screenshots/v1.2.2/
  • Removed outdated root-level screenshots (screenshot-main.png, screenshot-search.png)
  • All references updated to v1.2.2/ paths
  • Added tools/capture_screenshots.py for future regeneration

Structure

  • Features, Privacy, License, Build docs retained and reorganized under horizontal rules
  • Removed navigation header links (redundant with in-page sections)

Validation

  • 5 badges (Latest Release, AGPLv3, CI, Store placeholder, Windows)
  • No Store URL added (placeholder only — certification in progress)
  • No stable macOS claim
  • No application code changes
  • All screenshot paths verified

🤖 Generated with Claude Code

sparshsam and others added 3 commits June 19, 2026 12:47
- Repositioned messaging: 'Privacy-first PDF tools for humans and AI agents'
- Moved MCP/AI Agent section to top of README (after installation)
- Rewrote MCP content around outcomes/workflows (ask questions, search
  libraries, compare docs, summarize collections, build pipelines)
- Added ASCII MCP architecture diagram
- Simplified badges to 5: Release, AGPLv3, CI, Store (placeholder), Windows
- New screenshot directory: assets/screenshots/v1.2.2/
- Removed outdated root-level screenshots (screenshot-main, screenshot-search)
- All screenshot references updated to v1.2.2/ paths
- Added capture_screenshots.py tool for future regeneration

Co-Authored-By: Claude <noreply@anthropic.com>
- Changed 'Three ways to use OpenReader' table to 'Use OpenReader
  directly, from scripts, or through AI agents.'
- Copied missing about.png to assets/screenshots/v1.2.2/

Co-Authored-By: Claude <noreply@anthropic.com>
@sparshsam sparshsam merged commit 8a9a88c into main Jun 19, 2026
6 checks passed
@sparshsam sparshsam deleted the docs/mcp-positioning-refresh branch June 19, 2026 18:13
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