-
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add badge to readme #105
Add badge to readme #105
Conversation
WalkthroughThe pull request updates the README.md for a Stream Deck vATIS plugin. The changes primarily involve updating the required plugin version, adding a marketplace badge and download count, and removing the previous direct download link. These modifications aim to improve the plugin's documentation and provide easier access to the latest version through the official marketplace. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Build for this pull request: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
6-6
: Consider adding dark theme support for the marketplace badge.The marketplace badge currently uses a light theme SVG. Consider adding a dark theme version to improve visibility for users with dark themes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/marketplace-light.svg
is excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
(1 hunks)
🔇 Additional comments (2)
README.md (2)
4-4
: Verify compatibility with the new vATIS version requirement.The update to v4.1.0-beta.7 is a significant version bump. Since this is a beta version, please ensure:
- The plugin has been tested with this specific version
- Any breaking changes or new features in v4.1.0-beta.7 are properly handled
8-8
: Great addition of the download count badge!The dynamic badge implementation is well done:
- Uses shields.io for reliable badge generation
- Properly integrates with Elgato's marketplace API
- Includes a descriptive tooltip
Summary by CodeRabbit