Skip to content

docs: overhaul README with badges, features and how-it-works sections - #11

Merged
mpicciolli merged 1 commit into
mainfrom
docs/readme-overhaul
Jul 1, 2026
Merged

docs: overhaul README with badges, features and how-it-works sections#11
mpicciolli merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@mpicciolli

@mpicciolli mpicciolli commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Reworks the README into a more polished, npm-package-style landing page while keeping all technical details accurate.

  • Adds a centered header with npm version, license, node version and MCP-compatible badges
  • Introduces a Features section summarizing the server's capabilities
  • Adds a How it works section explaining the stateless, read-only, in-memory SQLite model
  • Consolidates the client install instructions (Claude/ChatGPT/Gemini via npx) into collapsible sections
  • Expands the Development section to list all available npm scripts (test:watch, coverage, pack, MCP Inspector)
  • Uses GitHub [!IMPORTANT] / [!NOTE] admonitions for the read-only guarantee and bundle auto-update caveat

All claims verified against package.json: Node >=22.0.0 and every referenced script (build, test, test:watch, coverage, lint, format, pack, inspector) exist.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes README.md into a more polished, npm-style landing page for the pcm-mcp MCP server, emphasizing core capabilities, safety guarantees, and clearer onboarding for multiple clients.

Changes:

  • Adds a centered header section with badges and a short product-style intro.
  • Introduces/expands Features, Getting started, and How it works sections to better explain capabilities and the stateless read-only architecture.
  • Consolidates installation instructions into collapsible sections and expands the Development section with commonly used scripts and MCP Inspector guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md
@mpicciolli
mpicciolli merged commit 5d6191c into main Jul 1, 2026
3 checks passed
@mpicciolli
mpicciolli deleted the docs/readme-overhaul branch July 1, 2026 22:25
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.

2 participants