Skip to content

Moved stuff around in the README to clean it up #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2025
Merged

Moved stuff around in the README to clean it up #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
<p align="center">
<img src="images/bitbom-long-logo.png" alt="BitBom Long Logo" >
<img src="images/bitbom-long-logo.png" alt="BitBom Long Logo">
</p>

[![Go Report Card](https://goreportcard.com/badge/github.com/bitbomdev/minefield)](https://goreportcard.com/report/github.com/bitbomdev/minefield)
[![Build and Test](https://github.com/bitbomdev/minefield/actions/workflows/build.yaml/badge.svg)](https://github.com/bitbomdev/minefield/actions/workflows/build.yaml)
<p align="center">
<a href="https://goreportcard.com/report/github.com/bitbomdev/minefield">
<img src="https://goreportcard.com/badge/github.com/bitbomdev/minefield" alt="Go Report Card">
</a>
<a href="https://github.com/bitbomdev/minefield/actions/workflows/build.yaml">
<img src="https://github.com/bitbomdev/minefield/actions/workflows/build.yaml/badge.svg" alt="Build and Test">
</a>
</p>

<p align="center">
<a href="https://bitbom.dev">🌐 Web</a> •
<a href="https://bitbom.dev/demos/starting-up-minefield/">📝 Demos</a> •
<a href="https://bitbom.dev/docs">📚 Docs</a> •
<a href="https://bitbom.dev/blog">📰 Blog</a>
</p>

**BitBom** Minefield uses roaring **Bit**maps to graph S**BOM**s with four main fundamentals:

Expand All @@ -13,23 +25,15 @@
* **Scalable**: Supports millions of nodes effortlessly.
* **Customizable**: Allows users to extend the project without relying on upstream changes.

---

>Before moving on, please consider giving us a GitHub star ⭐️. Thank you!
![Terminal Output](images/terminal.png)
> An example of Minefield caching ***10,000*** SBOMs packages transitive dependents in ***30 seconds***.

---


## Documentation

For comprehensive guides and detailed documentation, please visit our [Docs](https://bitbom.dev/docs).
>Before moving on, please consider giving us a GitHub star ⭐️. Thank you!

---


![Terminal Output](images/terminal.png)
> Caching 10,000 SBOMs packages transitive dependents in 30 seconds.

## Table of Contents

1. [Quickstart Guide](#quickstart-guide)
Expand Down
Loading