Revise README for manual workflow and support info

Updated README to include manual workflow setup and support project section.
This commit is contained in:
Patrick Ventuzelo
2025-10-16 22:31:22 +02:00
committed by GitHub
parent 794d5abc3a
commit 2edcc40cea
+19 -16
View File
@@ -46,13 +46,13 @@ FuzzForge is **open source**, built to empower security teams, researchers, and
--- ---
## ⭐ Support the Project ## Demo - Manual Workflow Setup
<a href="https://github.com/FuzzingLabs/fuzzforge_ai/stargazers"> ![Manual Workflow Demo](docs/static/videos/manual_workflow.gif)
<img src="https://img.shields.io/github/stars/FuzzingLabs/fuzzforge_ai?style=social" alt="GitHub Stars">
</a>
If you find FuzzForge useful, please star the repo to support development 🚀 _Setting up and running security workflows through the interface_
👉 More installation options in the [Documentation](https://docs.fuzzforge.ai).
--- ---
@@ -67,6 +67,16 @@ If you find FuzzForge useful, please star the repo to support development 🚀
--- ---
## ⭐ Support the Project
<a href="https://github.com/FuzzingLabs/fuzzforge_ai/stargazers">
<img src="https://img.shields.io/github/stars/FuzzingLabs/fuzzforge_ai?style=social" alt="GitHub Stars">
</a>
If you find FuzzForge useful, please star the repo to support development 🚀
---
## 🔍 Secret Detection Benchmarks ## 🔍 Secret Detection Benchmarks
FuzzForge includes three secret detection workflows benchmarked on a controlled dataset of **32 documented secrets** (12 Easy, 10 Medium, 10 Hard): FuzzForge includes three secret detection workflows benchmarked on a controlled dataset of **32 documented secrets** (12 Easy, 10 Medium, 10 Hard):
@@ -139,7 +149,10 @@ Run your first workflow with **Temporal orchestration** and **automatic file upl
git clone https://github.com/fuzzinglabs/fuzzforge_ai.git git clone https://github.com/fuzzinglabs/fuzzforge_ai.git
cd fuzzforge_ai cd fuzzforge_ai
# 2. Start FuzzForge with Temporal # 2. Copy the default LLM env config
cp volumes/env/.env.example volumes/env/.env
# 3. Start FuzzForge with Temporal
docker compose up -d docker compose up -d
``` ```
@@ -164,16 +177,6 @@ ff workflow run security_assessment . # Start workflow - CLI uploads files au
- **Vertical Workers**: Pre-built workers with security toolchains - **Vertical Workers**: Pre-built workers with security toolchains
- **Backend API**: FuzzForge REST API (http://localhost:8000) - **Backend API**: FuzzForge REST API (http://localhost:8000)
### Manual Workflow Setup
![Manual Workflow Demo](docs/static/videos/manual_workflow.gif)
_Setting up and running security workflows through the interface_
👉 More installation options in the [Documentation](https://docs.fuzzforge.ai).
---
## AI-Powered Workflow Execution ## AI-Powered Workflow Execution
![LLM Workflow Demo](docs/static/videos/llm_workflow.gif) ![LLM Workflow Demo](docs/static/videos/llm_workflow.gif)