Skip to content

Refresh README to cover features through v0.17.0#454

Merged
nitrobass24 merged 1 commit into
developfrom
docs/readme-feature-refresh
May 2, 2026
Merged

Refresh README to cover features through v0.17.0#454
nitrobass24 merged 1 commit into
developfrom
docs/readme-feature-refresh

Conversation

@nitrobass24
Copy link
Copy Markdown
Owner

Summary

  • Update Features list to reflect what shipped between v0.13.0 and v0.17.0: file integrity verification, Discord/Telegram/webhook notifications, multi-instance Sonarr/Radarr integration, staging directory, optional API key auth, virtual scrolling
  • Move Recommended Workflow (hard-link tip) up to follow Quick Start so new users see it before drowning in config
  • Add Configuration subsections for Notifications, Sonarr / Radarr, Staging Directory, and API Key — kept short, with pointers to the actual UI labels (Settings → Notifications, Settings → Integrations, Settings → Other Settings)
  • Add /staging row to the Volumes table

Why

The README's Features list stopped tracking around v0.13.0 (path pairs / webhooks). Several headline features have shipped since — most notably *arr integrations, Discord/Telegram presets, and inline integrity verification — that a user landing on the repo wouldn't know about from the README alone.

Out of scope

  • Did not add WEB_PORT to the env vars table — it only affects the Dockerfile healthcheck, not the listen port (that's web.port in the config), so it's not really user-facing config.

Test plan

  • Visual scan of the rendered README on the PR page — section order reads naturally
  • All UI labels referenced in the new Configuration subsections match the live Settings page
  • Volumes table renders correctly with the new /staging row

🤖 Generated with Claude Code

Updates the Features list with file integrity validation, Discord/Telegram/webhook notifications, Sonarr/Radarr integration, staging directory, and API key auth. Moves the hard-link Recommended Workflow up to follow Quick Start, adds Configuration subsections for the new settings, and lists /staging in the volumes table.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 2, 2026

Warning

Rate limit exceeded

@nitrobass24 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 33 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0e6a9b39-5fbe-4062-84a9-e063bd4c4806

📥 Commits

Reviewing files that changed from the base of the PR and between 0cc3533 and 3f8c29c.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-feature-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 11 minutes and 33 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@nitrobass24 nitrobass24 merged commit dc6b73b into develop May 2, 2026
28 of 30 checks passed
@nitrobass24 nitrobass24 deleted the docs/readme-feature-refresh branch May 2, 2026 05:08
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.

1 participant