Update readme

[neilenns]

Fixes #345
Fixes #346

Summary by CodeRabbit

• Documentation

  • Updated README.md with a note about TrackAudio beta version requirement
  • Simplified documentation structure
  • Removed detailed action descriptions and configuration details
  • Removed SVG templates documentation

• Chores

  • Streamlined project documentation

[coderabbitai]

Walkthrough

The pull request involves significant documentation changes, primarily focusing on simplifying the README.md and removing the entire SVG templates documentation file. The changes streamline the plugin's documentation by removing detailed action descriptions, configuration specifics, and SVG template explanations. Instead, the README now directs users to external documentation for more comprehensive setup and configuration guidance, while highlighting a key version requirement for TrackAudio.

Changes

File	Change Summary
README.md	- Added note about TrackAudio beta version requirement (1.3.0-beta.1+) - Replaced text link with marketplace image link - Removed detailed action descriptions - Eliminated configuration details and settings tables - Removed SVG template and profile examples - Added pointer to external documentation
docs/svgTemplates.md	- Entire file contents deleted - Removed documentation on SVG templates for various actions - Eliminated Handlebars placeholder and variable explanations

Poem

🐰 A Rabbit's Documentation Dance

Trim the docs, make them light and neat,
Marketplace link, a streamlined treat!
SVG templates, bid them farewell,
Documentation's magical spell ✨
Simplicity hops, with grace so fair! 🌈

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca30149 and fad2e51.

⛔ Files ignored due to path filters (33)

• com.neil-enns.trackaudio.sdPlugin/images/actions/hotline/hotline.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/pushToTalk/pushtotalk.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/stationStatus/stationstatus.svg is excluded by !**/*.svg
• com.neil-enns.trackaudio.sdPlugin/images/actions/trackAudioStatus/trackaudiostatus.svg is excluded by !**/*.svg
• docs/example.png is excluded by !**/*.png
• docs/images/atis-current.png is excluded by !**/*.png
• docs/images/atis-unavailable.png is excluded by !**/*.png
• docs/images/atis-updated.png is excluded by !**/*.png
• docs/images/button-example.png is excluded by !**/*.png
• docs/images/button-example.psd is excluded by !**/*.psd
• docs/images/examples/sea-app-atis.png is excluded by !**/*.png
• docs/images/examples/sea-twr.png is excluded by !**/*.png
• docs/images/hotline-active.png is excluded by !**/*.png
• docs/images/hotline-both.png is excluded by !**/*.png
• docs/images/hotline-listening.png is excluded by !**/*.png
• docs/images/hotline-neither.png is excluded by !**/*.png
• docs/images/hotline-receiving.png is excluded by !**/*.png
• docs/images/hotline-unavailable.png is excluded by !**/*.png
• docs/images/ptt-idle.png is excluded by !**/*.png
• docs/images/ptt-transmitting.png is excluded by !**/*.png
• docs/images/station-status.png is excluded by !**/*.png
• docs/images/stationstatus-blocked.png is excluded by !**/*.png
• docs/images/stationstatus-listening.png is excluded by !**/*.png
• docs/images/stationstatus-muted.png is excluded by !**/*.png
• docs/images/stationstatus-notlistening.png is excluded by !**/*.png
• docs/images/stationstatus-receiving.png is excluded by !**/*.png
• docs/images/stationstatus-unavailable.png is excluded by !**/*.png
• docs/images/streamdeck-category.png is excluded by !**/*.png
• docs/images/trackAudio.png is excluded by !**/*.png
• docs/images/trackaudiostatus-connected.png is excluded by !**/*.png
• docs/images/trackaudiostatus-notconnected.png is excluded by !**/*.png
• docs/images/trackaudiostatus-voiceconnected.png is excluded by !**/*.png
• docs/marketplace-light.svg is excluded by !**/*.svg

📒 Files selected for processing (2)

• README.md (1 hunks)
• docs/svgTemplates.md (0 hunks)

💤 Files with no reviewable changes (1)

• docs/svgTemplates.md

🔇 Additional comments (5)

README.md (5)

Line range hint 1-4: Well-structured version requirement notice!

The warning is prominently placed and clearly communicates the version dependency using GitHub's alert syntax.

---

8-10: Excellent use of example image with descriptive alt text!

The combination of concise description and well-documented example image effectively demonstrates the plugin's capabilities.

---

14-14: Good cross-reference to related plugin!

The vATIS plugin reference provides valuable information for users who might benefit from complementary functionality.

---

12-12: Verify external documentation link accessibility.

Please verify that the documentation URL is accessible and contains the referenced setup information.

---

6-6: Verify marketplace image path and consider dark mode support.

The marketplace link is functional, but please verify:

1. The image path docs/marketplace-light.svg exists in the repository
2. Consider adding a dark theme version of the marketplace badge for better dark mode support

✅ Verification successful

Image path verified, dark mode support recommended

The marketplace badge image exists at the correct path. Consider adding a dark theme version of the badge for better dark mode support.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the marketplace image exists
fd "marketplace-light.svg" docs/

Length of output: 59

---

Script:

#!/bin/bash
# Check for dark mode variants of the marketplace badge
fd "marketplace.*dark.*\.svg" docs/

Length of output: 37

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Build for this pull request:
StreamDeck-TrackAudio.zip