Moved stuff around in the README to clean it up

[naveensrinivasan]

Summary by CodeRabbit

• Documentation
  • Updated README with improved formatting and presentation
  • Added new links to BitBom website, demos, documentation, and blog
  • Replaced terminal output description with an image
  • Reformatted caching description into a block quote

[coderabbitai]

Walkthrough

The pull request focuses on enhancing the README.md file for the BitBom project. The changes involve restructuring the content, improving the presentation of badges, adding new resource links, and replacing text with an image of terminal output. The modifications aim to improve the document's clarity, accessibility, and visual appeal while maintaining the core informational content.

Changes

File	Change Summary
README.md	- Removed unnecessary space in BitBom logo <img> tag - Encapsulated badges in <p> tag for better alignment - Added new links to website, demos, documentation, and blog - Replaced terminal output text with an image - Reformatted caching description into a block quote

Possibly related PRs

• 📖 Updated README #165: Updates to README.md badge links
• Updated README #186: Added documentation section and terminal output image

Suggested reviewers

• neilnaveen

Poem

🐰 A README's tale, crisp and bright,
Badges aligned with pixel-perfect might
Links dancing, images so clear
BitBom's story now shines without fear
A rabbit's touch of documentation flair! 🔧

---

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.

[neilnaveen]

LGTM

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

28-28: Add alt text for accessibility.

Consider adding descriptive alt text to the terminal output image to improve accessibility.

-![Terminal Output](images/terminal.png)
+![Terminal Output showing Minefield caching 10,000 SBOMs packages in 30 seconds](images/terminal.png)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26d46d4 and c01681a.

📒 Files selected for processing (1)

• README.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Build and Scan
• GitHub Check: build
• GitHub Check: Analyze (go)
• GitHub Check: Analyze (go)

🔇 Additional comments (3)

README.md (3)

1-12: Well-structured HTML with proper accessibility!

The logo and badges section is well-organized with proper HTML structure, centered alignment, and accessibility features (alt text).

---

14-19: Great navigation design with visual cues!

The quick links section provides easy access to key resources with consistent styling and helpful emoji indicators.

---

Line range hint 33-200: Excellent documentation structure!

The content is well-organized with:

• Clear navigation through table of contents
• Detailed examples and instructions
• Consistent formatting throughout

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅