Skip to content

Update README for v2.2 (multi-format, URL import, content studio, uninstall)#42

Merged
nmbrthirteen merged 1 commit into
mainfrom
docs/readme-v2.2
Jul 5, 2026
Merged

Update README for v2.2 (multi-format, URL import, content studio, uninstall)#42
nmbrthirteen merged 1 commit into
mainfrom
docs/readme-v2.2

Conversation

@nmbrthirteen

@nmbrthirteen nmbrthirteen commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Brings the README in line with what shipped in v2.2.0/v2.2.1.

  • Fixes an now-incorrect (and unsafe) uninstall section — it still claimed uninstall keeps your config/knowledge/presets/history and that --purge removes them. As of v2.2.1 uninstall removes all managed data by default and --purge is a no-op; the section now says so and points at --dry-run.
  • Headline + flow now cover 9:16 / 16:9 / 1:1 output instead of vertical-only.
  • Features: added multi-format output, import from a URL (YouTube/direct link via yt-dlp), and the content studio (in-UI title/description/tags/hashtag generation with per-section regenerate + custom prompts).
  • Stars badge: dropped cacheSeconds=86400 so a transient shields.io rate-limit "invalid" self-heals in minutes instead of being cached for a day.

Docs-only.

Summary by CodeRabbit

  • New Features

    • Added support for generating clips in multiple aspect ratios, including vertical, landscape, and square.
    • Added the ability to import content from a URL.
    • Expanded the web experience with content-studio guidance for generating and refining titles, descriptions, tags, and hashtags.
  • Documentation

    • Updated setup and usage guidance to reflect the latest video-processing, audio, and uninstall behavior.
    • Clarified cleanup options, including dry-run behavior and default removal of managed data.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6a03002b-f513-43cd-92a6-34650f0ae426

📥 Commits

Reviewing files that changed from the base of the PR and between 62681a6 and 9d422b0.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR updates README.md documentation only: revised hero tagline mentioning multiple aspect ratios, a badge URL change, updated workflow diagram text, new feature bullets (multi-format output, URL import, content studio), and rewritten uninstall documentation clarifying scope, dry-run behavior, and the --purge alias.

Changes

README documentation updates

Layer / File(s) Summary
Hero tagline, badge, and workflow diagram updates
README.md
Tagline now mentions 9:16, 16:9, or 1:1 formats with face tracking; stars badge URL drops the cacheSeconds parameter; render-clips workflow stage text now mentions normalized audio.
Feature list additions
README.md
Adds Video Processing bullets for multi-format output and URL import, and a new Infrastructure bullet describing the content studio web UI.
Uninstall documentation rewrite
README.md
Clarifies that uninstall removes the managed folder (config/knowledge/presets/assets/history) by default, documents --dry-run behavior and backup guidance, and states --purge is a no-op alias.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README docs update and highlights the main v2.2 changes included in the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-v2.2

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

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

@nmbrthirteen nmbrthirteen merged commit f9c6f30 into main Jul 5, 2026
5 checks passed
@nmbrthirteen nmbrthirteen deleted the docs/readme-v2.2 branch July 5, 2026 12:05
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