docs(readme): Improve remote repository usage examples

[yamadashy]

Checklist

• Run npm run test
• Run npm run lint

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[standard-input]

No issues flagged.
Standard Input can make mistakes. Check important info.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the README.md file for the Repomix project, focusing on modernizing command-line usage instructions for remote repository processing. The primary changes include updating branch references from "master" to "main" and demonstrating the ability to specify branches, tags, or commit hashes using the --remote-branch parameter. These modifications reflect current best practices in repository management and provide more flexible repository reference options.

Changes

File	Change Summary
README.md	- Replaced "master" branch references with "main" - Added example of using specific commit hash (935b695) - Updated command usage instructions for repomix --remote

Possibly related PRs

• Update README.md #199: Updates README.md documentation for the --remote-branch option
• Support commit SHA in --remote-branch option #212: Adds support for commit SHA values in the --remote-branch option
• docs(readme): Separate docker commands for easier copy & paste #230: Introduces Docker usage section in README.md documentation

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.16%. Comparing base (935b695) to head (53accf8).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #232   +/-   ##
=======================================
  Coverage   92.16%   92.16%           
=======================================
  Files          44       44           
  Lines        2080     2080           
  Branches      458      458           
=======================================
  Hits         1917     1917           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

91-92: LGTM! Consider adding a note about commit hash length.

The example effectively demonstrates using a specific commit hash. Consider adding a note mentioning that both short (7 characters) and full-length commit hashes are supported.

 # Or use a specific commit hash:
-repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695
+repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695  # Short hash
+# Full length hash is also supported
+repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695a3d4b1c2e3f4a5b6c7d8e9f0a1b2c3d4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 935b695 and 53accf8.

📒 Files selected for processing (1)

• README.md (3 hunks)

🔇 Additional comments (4)

README.md (4)

87-88: LGTM! Good addition of GitHub shorthand syntax.

The added note about GitHub shorthand provides users with a convenient alternative syntax, making the documentation more user-friendly.

---

88-90: LGTM! Clear example of branch specification.

The example effectively demonstrates branch specification while following modern Git practices by using "main" as the default branch.

---

329-329: LGTM! Consistent command line example.

The example maintains consistency with earlier examples and is appropriately placed in the command line options section.

---

355-373: LGTM! Comprehensive and well-structured remote repository documentation.

The section provides a clear progression from basic to advanced usage, with consistent examples and thorough coverage of all remote repository features.