docs: update README.md with install and feature sections#61
Merged
Conversation
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
changed the title
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.
WilliamBergamin
requested changes
Jun 29, 2026
WilliamBergamin
left a comment
WilliamBergamin
left a comment
Contributor
There was a problem hiding this comment.
This is great 💯 much better then what we had
My only blocker is around the description of the project I think we can make it shorter and more general?
| We welcome contributions from everyone! Please check out our [contributor's guide](.github/contributing.md) for guidelines on opening issues and pull requests. | ||
|
|
||
| ## Questions or Issues? | ||
| Working on the plugin itself? See the [maintainer's guide](.github/maintainers_guide.md) for local development setup. |
|
|
||
| - **Remote server only**: This configuration connects to Slack's hosted MCP server. No local installation is required or supported. | ||
| - **Admin approval required**: Your Slack workspace administrator must approve MCP integration before you can use this feature. | ||
| We welcome contributions from everyone! Please check out our [contributor's guide](.github/contributing.md) for guidelines on opening issues and pull requests. |
Member
Author
|
Thanks for the quick review @WilliamBergamin! I've brought in one of your suggestions and incorporated your other suggestion to shorted the tagline. Let me know what you think! |
Co-authored-by: William Bergamin <wbergamin@salesforce.com>
WilliamBergamin
approved these changes
Jun 29, 2026
WilliamBergamin
left a comment
WilliamBergamin
left a comment
Contributor
There was a problem hiding this comment.
Looks good 💯 great upgrade 🚀
Member
Author
|
Thanks for the review @WilliamBergamin! We can keep iterating on the README.md but I think this is much better than what we have today. Let's ship it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request updates the
README.mdto be the front door for external Claude Code and Cursor users, instead of plugin maintainers./plugin install slack@claude-plugins-official) alongside the existing Cursor deeplink.Testing