Skip to content

Commit 72302b5

Browse files
Zie619claude
andcommitted
docs: update main README with new demo GIF and one-node n8n setup
Replace old demo GIF with full screen recording showing community node install, workflow activation, and live dashboard. Update n8n section to document the one-node TruseraWebhook setup and list all 5 nodes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 02a13ac commit 72302b5

File tree

2 files changed

+22
-14
lines changed

2 files changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -92,27 +92,35 @@ pipx install ai-bom
9292

9393
## n8n Community Node
9494

95-
Scan all your n8n workflows for AI security risks — directly inside n8n.
95+
Scan all your n8n workflows for AI security risks — directly inside n8n. One node, full dashboard.
9696

97-
```bash
98-
npm install n8n-nodes-trusera
99-
```
97+
**Install:** Settings > Community Nodes > `n8n-nodes-trusera`
98+
99+
### Setup (1 minute)
100+
101+
1. Add the **Trusera Webhook** node to a workflow
102+
2. Add your n8n API credential (Settings > n8n API > Create API Key)
103+
3. Activate the workflow
104+
4. Visit `http://your-n8n-url/webhook/trusera`
100105

101-
Or install via the n8n UI: **Settings > Community Nodes > Install > `n8n-nodes-trusera`**
106+
That's it. The node fetches all workflows, scans them, and serves an interactive HTML dashboard.
102107

103-
### Setup
108+
### Included Nodes
104109

105-
1. Add a **Trusera Dashboard** node to a workflow
106-
2. Create credentials with your n8n API URL and API key
107-
3. Optionally set a dashboard password for AES-256-GCM encryption
108-
4. Execute the node — it fetches all workflows, scans them, and returns an interactive HTML dashboard
110+
| Node | Purpose |
111+
|------|---------|
112+
| **Trusera Webhook** | One-node dashboard at `/webhook/trusera` (recommended) |
113+
| **Trusera Dashboard** | Chain with built-in Webhook for custom setups |
114+
| **Trusera Scan** | Programmatic scanning — returns JSON for CI/CD pipelines |
115+
| **Trusera Policy** | Security gates — pass/fail against configurable policies |
116+
| **Trusera Report** | Markdown/JSON reports for Slack, email, or docs |
109117

110118
### Dashboard features
111119

112-
- Severity distribution charts and risk score stat cards
113-
- Sortable findings table with search and severity/type filters
114-
- Per-finding remediation cards with actionable fix steps and guardrail recommendations
115-
- OWASP LLM Top 10 category mapping for every risk flag
120+
- Severity distribution charts, component type breakdown, and OWASP LLM Top 10 mapping
121+
- Scanned workflows table with trigger type, component count, and risk severity
122+
- Sortable findings table with search, severity/type/workflow filters
123+
- Per-finding remediation cards with actionable fix steps
116124
- CSV and JSON export
117125
- Light/dark theme toggle
118126
- Optional password protection (AES-256-GCM encrypted, client-side decryption)

assets/n8n-demo.gif

2.88 MB
Loading

0 commit comments

Comments
 (0)