From 2edcc40cea42844654f26f5d49a0e513da28ac14 Mon Sep 17 00:00:00 2001 From: Patrick Ventuzelo <9038181+pventuzelo@users.noreply.github.com> Date: Thu, 16 Oct 2025 22:31:22 +0200 Subject: [PATCH] Revise README for manual workflow and support info Updated README to include manual workflow setup and support project section. --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b88eeff..968ca46 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,13 @@ FuzzForge is **open source**, built to empower security teams, researchers, and --- -## ⭐ Support the Project +## Demo - Manual Workflow Setup - - GitHub Stars - +![Manual Workflow Demo](docs/static/videos/manual_workflow.gif) -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 + + + GitHub Stars + + +If you find FuzzForge useful, please star the repo to support development 🚀 + +--- + ## 🔍 Secret Detection Benchmarks 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 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 ``` @@ -164,16 +177,6 @@ ff workflow run security_assessment . # Start workflow - CLI uploads files au - **Vertical Workers**: Pre-built workers with security toolchains - **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 ![LLM Workflow Demo](docs/static/videos/llm_workflow.gif)