diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 85c4909..e2cf828 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -3,7 +3,8 @@ name: Deploy Docusaurus to GitHub Pages on: push: branches: - - main + - master + workflow_dispatch: jobs: build: @@ -30,7 +31,7 @@ jobs: - name: Upload Build Artifact uses: actions/upload-pages-artifact@v3 with: - path: build + path: ./docs/build deploy: name: Deploy to GitHub Pages diff --git a/.github/workflows/docs-test-deploy.yml b/.github/workflows/docs-test-deploy.yml index 388abbc..9c7d2d9 100644 --- a/.github/workflows/docs-test-deploy.yml +++ b/.github/workflows/docs-test-deploy.yml @@ -3,7 +3,7 @@ name: Docusaurus test deployment on: pull_request: branches: - - main + - master jobs: test-deploy: diff --git a/README.md b/README.md index 35f7abf..d5ef67f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

- FuzzForge Banner + FuzzForge Banner

-

FuzzForge 🚧

+

🚧 FuzzForge is under active development

AI-powered workflow automation and AI Agents for AppSec, Fuzzing & Offensive Security

@@ -9,9 +9,9 @@ Discord License: BSL + Apache Python 3.11+ - Website + Website Version - GitHub Stars + GitHub Stars

@@ -21,8 +21,9 @@ • FeaturesInstallationQuickstart - • Demo + • AI DemoContributing + • Roadmap

@@ -45,8 +46,8 @@ FuzzForge is **open source**, built to empower security teams, researchers, and ## ⭐ Support the Project - - GitHub Stars + + GitHub Stars If you find FuzzForge useful, please star the repo to support development 🚀 @@ -97,7 +98,7 @@ uv tool install --python python3.12 . ## ⚡ Quickstart -Run your first workflow in **3 steps**: +Run your first workflow : ```bash # 1. Clone the repo @@ -119,7 +120,7 @@ docker compose up -d # 3. Run your first workflow cd test_projects/vulnerable_app/ # Go into the test directory fuzzforge init # Init a fuzzforge project -ff workflow security_assessment . # Start a workflow (you can also use ff command) +ff workflow run security_assessment . # Start a workflow (you can also use ff command) ``` ### Manual Workflow Setup diff --git a/docs/static/img/fuzzforge_banner_github.png b/docs/static/img/fuzzforge_banner_github.png new file mode 100644 index 0000000..8bedc42 Binary files /dev/null and b/docs/static/img/fuzzforge_banner_github.png differ