Skip to content

Commit 2edcc40

Browse files
authored
Revise README for manual workflow and support info
Updated README to include manual workflow setup and support project section.
1 parent 794d5ab commit 2edcc40

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ FuzzForge is **open source**, built to empower security teams, researchers, and
4646
4747
---
4848

49-
## ⭐ Support the Project
49+
## Demo - Manual Workflow Setup
5050

51-
<a href="https://github.com/FuzzingLabs/fuzzforge_ai/stargazers">
52-
<img src="https://img.shields.io/github/stars/FuzzingLabs/fuzzforge_ai?style=social" alt="GitHub Stars">
53-
</a>
51+
![Manual Workflow Demo](docs/static/videos/manual_workflow.gif)
5452

55-
If you find FuzzForge useful, please star the repo to support development 🚀
53+
_Setting up and running security workflows through the interface_
54+
55+
👉 More installation options in the [Documentation](https://docs.fuzzforge.ai).
5656

5757
---
5858

@@ -67,6 +67,16 @@ If you find FuzzForge useful, please star the repo to support development 🚀
6767

6868
---
6969

70+
## ⭐ Support the Project
71+
72+
<a href="https://github.com/FuzzingLabs/fuzzforge_ai/stargazers">
73+
<img src="https://img.shields.io/github/stars/FuzzingLabs/fuzzforge_ai?style=social" alt="GitHub Stars">
74+
</a>
75+
76+
If you find FuzzForge useful, please star the repo to support development 🚀
77+
78+
---
79+
7080
## 🔍 Secret Detection Benchmarks
7181

7282
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
139149
git clone https://github.com/fuzzinglabs/fuzzforge_ai.git
140150
cd fuzzforge_ai
141151

142-
# 2. Start FuzzForge with Temporal
152+
# 2. Copy the default LLM env config
153+
cp volumes/env/.env.example volumes/env/.env
154+
155+
# 3. Start FuzzForge with Temporal
143156
docker compose up -d
144157
```
145158

@@ -164,16 +177,6 @@ ff workflow run security_assessment . # Start workflow - CLI uploads files au
164177
- **Vertical Workers**: Pre-built workers with security toolchains
165178
- **Backend API**: FuzzForge REST API (http://localhost:8000)
166179

167-
### Manual Workflow Setup
168-
169-
![Manual Workflow Demo](docs/static/videos/manual_workflow.gif)
170-
171-
_Setting up and running security workflows through the interface_
172-
173-
👉 More installation options in the [Documentation](https://docs.fuzzforge.ai).
174-
175-
---
176-
177180
## AI-Powered Workflow Execution
178181

179182
![LLM Workflow Demo](docs/static/videos/llm_workflow.gif)

0 commit comments

Comments
 (0)