diff --git a/README.md b/README.md index e77de0f..3c5c84e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # 🐴 RiskRancher Core (Community Edition) -> So simple your manager could deploy it. +RiskRancher Core is an open-source **Risk-Based Vulnerability Management (RBVM)** and **ASPM** platform built for modern +DevSecOps teams. -RiskRancher Core is an open-source **Risk-Based Vulnerability Management (RBVM)** and **ASPM** platform built for modern DevSecOps teams. Compiled as a lightning-fast, **air-gapped single Go binary** with an embedded SQLite database, it ingests, deduplicates, and routes millions of security findings from your CI/CD pipelines and scanners. +Compiled as a lightning-fast, **air-gapped single Go binary** with an embedded SQLite database, it ingests, deduplicates, +and routes millions of security findings from your CI/CD pipelines and scanners. -No external databases to spin up, no Docker swarms to manage, and zero complex microservices. Just drop the binary on a server and start triaging. +No external databases to spin up, no Docker swarms to manage, and zero complex microservices. +Just drop the binary on a server and start triaging. -## 🚀 Getting Started +## Getting Started -### Option A: Download the Binary (Recommended) -1. Go to the [Releases](#) tab and download the compiled executable for your OS (Windows/macOS/Linux). +### Option A: Download the Binary + +1. Go to the [Releases](https://epigas.gitea.cloud/RiskRancher/core/releases) tab and download the compiled executable for your OS (Windows/macOS/Linux). 2. Place the binary in a dedicated directory and execute it. 3. Visit `http://localhost:8080` in your browser. ### Option B: Compile from Source + Ensure you have **Go 1.26+** installed (*CGO is required for the native `mattn/go-sqlite3` driver*). ```bash -git clone [https://gitea.yourdomain.com/RiskRancher/core.git](https://gitea.yourdomain.com/RiskRancher/core.git) +git clone https://epigas.gitea.cloud/RiskRancher/core cd core go build -o rr ./cmd/rr/main.go ./rr