docs: enhance project readme

[edhor1608]

Note

Expand README with usage examples, output rules, and project structure

Rewrites README.md to give a fuller picture of how Passepartout works and how to use it.

• Adds a 'What It Does' section covering canvas behavior, export ratios/sizes, border defaults, EXIF orientation, metadata stripping, and overwrite avoidance
• Expands the 'Usage' section with separate examples for single-file, directory, and custom border inputs
• Clarifies --out and --border-px semantics in 'Options'
• Replaces 'Rules' with 'Output Rules', split into I/O behavior and layout/rendering behavior
• Adds a 'Project Structure' section listing key source files and tests

^{Macroscope summarized 8dedf53.}

Summary by CodeRabbit

• Documentation
  • Enhanced documentation with clearer explanation of v1 behavior and default settings
  • Improved usage examples with separate instructions for single and batch image processing
  • Added custom border configuration examples
  • Documented output rules and project structure overview

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR updates README.md to improve documentation clarity and organization. The opening description and "What It Does" section are expanded to enumerate specific v1 product behaviors including white-canvas output, border defaults, EXIF handling, and metadata stripping. The "Usage" section is restructured to separate single-image and directory processing examples, adds a border customization example, and splits options and output rules into distinct subsections. A new "Project Structure" section lists key source files by functional role, and the "Docs" list is updated to reference additional planning documentation.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: enhance project readme' directly and accurately describes the main change—a comprehensive rewrite and reorganization of the README documentation with new sections and improved clarity.
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/enhance-readme

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch codex/enhance-readme

---

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

[edhor1608]

• feat: bundle ffmpeg binaries #62
• docs: enhance project readme #61 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[edhor1608]

Merge activity

• May 21, 1:26 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• May 21, 1:26 PM UTC: @edhor1608 merged this pull request with Graphite.