Update README.md

[guibranco]

Closes #

📑 Description

✅ Checks

• My pull request adheres to the code style of this project
• My code requires changes to the documentation
• I have updated the documentation as required
• All the tests have passed

☢️ Does this introduce a breaking change?

• Yes
• No

ℹ Additional Information

Summary by CodeRabbit

• Documentation
  • Updated the README.md to include a new "Example output" section showcasing commit messages generated by the tool, complete with a visual representation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve the addition of a new section titled "Example output" in the README.md file. This section provides a visual example of commit messages generated by the tool, enhancing documentation clarity. The new section is appended after the existing "Commands" section, while the rest of the content remains largely unchanged.

Changes

File	Change Summary
README.md	Added a new section "Example output" with an image illustrating commit messages.

Possibly related PRs

• Improve formatting and clarity in README.md #3: This PR improves formatting and clarity in README.md, which is relevant as both PRs involve updates to the same file.
• Enhance README with installation and usage instructions #20: This PR enhances the README.md with installation and usage instructions, which relates to the overall documentation improvements seen in the main PR.
• Enhance README.md with git log usage instructions #21: This PR adds instructions for using git log -1 in README.md, which aligns with the main PR's focus on enhancing documentation clarity.
• Enhance README with Hyperlinks for Requirements #24: This PR updates the README.md with hyperlinks for requirements, further enhancing usability as noted in the main PR.
• Update image link in README.md for better accessibility #25: This PR updates an image link in README.md, which relates to the visual representation aspect mentioned in the main PR.
• Improve README.md with corrections and requirements #26: This PR includes grammatical corrections and a new "Requirements" section in README.md, relevant to the documentation enhancements.
• Enhance README with Command Descriptions #27: This PR introduces a new section titled "Commands" in README.md, which is relevant as it also contributes to the documentation improvements.
• Enhance README with Badges and Installation Instructions #28: This PR adds installation instructions and badges to README.md, contributing to overall clarity improvements.
• Update README.md with CI Badges #29: This PR introduces CI badges in README.md, enhancing the documentation's informational content.
• Update README.md #101: This PR makes textual modifications for clarity in README.md, which is directly related to the main PR's goal of enhancing documentation.

Suggested labels

size/S, Review effort [1-5]: 1, documentation

Suggested reviewers

• gstraccini

🐇 In the README, a new sight,
An "Example output" shines so bright.
With visuals clear, our tool's delight,
Commit messages now take flight!
Documentation's charm, we celebrate,
Hop along, let's elevate! 🐇✨

---

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

[deepsource-io]

Here's the code health analysis summary for commits ee9eb7b..1335c2c. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Shell	✅ Success		View Check ↗
Test coverage	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
Docker	✅ Success		View Check ↗
C#	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	C#
Branch Coverage	5.9%	5.9%
Condition Coverage	5.9%	5.9%
Composite Coverage	7.3%	7.3%
Line Coverage	7.7%	7.7%

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

11:17AM INF scanning for exposed secrets...
11:17AM INF 186 commits scanned.
11:17AM INF scan completed in 86.7ms
11:17AM INF no leaks found