📝 docs: add comparison screenshots to README

[135yshr]

Summary

• README 冒頭の TODO プレースホルダを、examples/06-japanese-document の出力をヒーロー画像として差し替え
• 同じ日本語 PRD を Pandoc / md-to-pdf / md2pdf で変換した結果を並べた比較セクションを追加し、md2pdf が解決するユースケース（CJK + Mermaid のゼロコンフィグ対応）を視覚的に提示
• 比較スクリーンショット3枚を docs/images/comparison/ 配下に新規追加

Test plan

• README をブラウザ（GitHub上）で確認し、ヒーロー画像と比較表の3枚が崩れずに表示されることを確認
• 各画像の alt テキスト・キャプションが意図通りであることを確認
• 画像パス（docs/images/comparison/*.png）が正しくリンクしていることを確認

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

• Added a centered visual introduction block with a sample image and descriptive caption positioned near the top of the README
• Introduced new "Comparison with other tools" section that details md2pdf's positioning in the market and includes a comprehensive comparison table highlighting feature differences with competing document conversion solutions

[coderabbitai]

Warning

Rate limit exceeded

@135yshr has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 54 minutes and 51 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 63bcd41a-3b96-4349-981d-7debcb91d93a

📥 Commits

Reviewing files that changed from the base of the PR and between 239cf0c and 721b7f2.

⛔ Files ignored due to path filters (3)

• docs/images/comparison/after-md2pdf-japanese.png is excluded by !**/*.png
• docs/images/comparison/before-md-to-pdf-japanese.png is excluded by !**/*.png
• docs/images/comparison/before-pandoc-japanese.png is excluded by !**/*.png

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

Documentation update to README.md: added a centered image block with caption showcasing sample PDF output, removed a TODO placeholder, and inserted a new "Comparison with other tools" section with descriptive text and a comparison table for Pandoc, md-to-pdf, and md2pdf.

Changes

Documentation Updates

Layer / File(s)	Summary
Introduction README.md	Centered image block with caption added near the top to showcase sample PDF output.
Tool Comparison README.md	New "Comparison with other tools" section added with descriptive content and table comparing Pandoc, md-to-pdf, and md2pdf.
Cleanup README.md	TODO placeholder referencing before-after image removed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through words so fine,
With images and tables in a line!
We've cleared the clutter, added shine,
This README now will surely shine! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title mentions 'comparison screenshots' but the actual changes show a comparison table and centered image, not multiple screenshots as the primary feature.	Clarify whether the title should reference the 'comparison table' or 'comparison section' instead of 'screenshots', or confirm that screenshots are the main focus of this PR.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/comparison-images

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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