Skip to content

docs: update README.md with install and feature sections#61

Open
mwbrooks wants to merge 2 commits into
mainfrom
mwbrooks-readme-skills-plugin
Open

docs: update README.md with install and feature sections#61
mwbrooks wants to merge 2 commits into
mainfrom
mwbrooks-readme-skills-plugin

Conversation

@mwbrooks

@mwbrooks mwbrooks commented Jun 25, 2026

Copy link
Copy Markdown
Member

Summary

This pull request updates the README.md to be the front door for external Claude Code and Cursor users, instead of plugin maintainers.

  • Renames the title to Slack MCP and Skills Plugin and adds a tagline.
  • Adds CI / license badges.
  • Moves Installation above Features so the first action a reader can take is install.
  • Documents the official Claude marketplace install (/plugin install slack@claude-plugins-official) alongside the existing Cursor deeplink.
  • Lists the complete features: MCP server capabilities, all six skills, and all five slash commands.
  • Adds developer-focused usage examples (create a Slack app, build a Block Kit feedback modal, validate Block Kit JSON from a file).
  • Links to the contributor and maintainer guides for contributions.

Testing

  • Open the rendered README in the GitHub PR preview and confirm the title, badges, Cursor "Install MCP Server" button, and all section headings render correctly.

Refocuses the README on Claude Code and Cursor end users instead of
plugin maintainers. Title becomes "Slack MCP and Skills Plugin",
install section leads, Features lists the MCP server tools, the six
skills, and the five slash commands, and maintainer setup moves to
.github/contributing.md and .github/maintainers_guide.md.
@mwbrooks mwbrooks changed the title docs: rewrite README for external users docs: update README.md with install and feature sections Jun 25, 2026
@mwbrooks mwbrooks self-assigned this Jun 25, 2026
@mwbrooks mwbrooks added the documentation Improvements or additions to documentation label Jun 25, 2026
Mirrors the slackapi/slack-cli README: a single Contributing
section that links to .github/contributing.md (covers issues and
PRs) and to .github/maintainers_guide.md for local development.
@mwbrooks mwbrooks marked this pull request as ready for review June 25, 2026 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant