From bf01fa001a23e81b5b18c55176d32cb97abc6b8e Mon Sep 17 00:00:00 2001 From: monoxgas Date: Mon, 4 May 2026 14:03:40 -0600 Subject: [PATCH] Reshape README as a signpost to docs and install paths MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Frames the repo as the source for dreadnode/* capabilities and routes landing users to the right resource — TUI, CLI install, or local checkout — with concrete examples that name a real capability rather than placeholder slugs. Conceptual and build-it questions point at the overview, manifest, and quickstart docs. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6467660..a6bef8e 100644 --- a/README.md +++ b/README.md @@ -20,19 +20,35 @@ Dreadnode Capabilities
-This repo maintains the source for all our capabilities published to [app.dreadnode.io](https://app.dreadnode.io). +This is the source repo for the capabilities Dreadnode publishes to [app.dreadnode.io](https://app.dreadnode.io). A capability is a directory — a manifest plus any combination of agents, tools, skills, MCP servers, and workers — that a Dreadnode runtime can pick up and load: + +```text +threat-hunting/ + capability.yaml # manifest + agents/ # markdown prompts + tools/ # python @tool functions + skills/ # SKILL.md packs +``` + +Welcome — the rest of this README is a quick map to wherever you're trying to go. + +## Looking to use one? + +Pick whichever fits — same capabilities, three ways in: -Full reference for the manifest, components, discovery rules, installation, and publishing lives in the docs: +- **Install the published version** — `dn capability install dreadnode/ai-red-teaming` (swap in any name from `capabilities/`) +- **Run the source from this repo** — `dn capability install ./capabilities/ai-red-teaming` symlinks the directory into your runtime, so edits go live on reload +- **Browse from inside the runtime** — start `dn`, press `Ctrl+P`, filter for `dreadnode/` -**[docs.dreadnode.io/capabilities/overview](https://docs.dreadnode.io/capabilities/overview/)** +Full install reference: [docs.dreadnode.io/capabilities/installing](https://docs.dreadnode.io/capabilities/installing/). -For an end-to-end walkthrough — scaffold, write a tool and an agent, install locally, drive it from the TUI — start with the [Quickstart](https://docs.dreadnode.io/capabilities/quickstart/). +## Curious how they work, or want to build one? -## How to use +This is a great place to be — every directory under `capabilities/` is a real, shipped example you can read alongside the docs: -- **Install in the TUIr** — start `dn`, press `Ctrl+P` and find one of the `dreadnode/` capabilities. -- **Browse the catalog** — interactively browse everything published at [app.dreadnode.io](https://app.dreadnode.io). -- **Local checkout** — drop a capability directory in `~/.dreadnode/capabilities/` (or anywhere on `DREADNODE_CAPABILITY_DIRS`) and the runtime picks it up. +- **Concepts and load model** — [overview](https://docs.dreadnode.io/capabilities/overview/) +- **Manifest reference** — [manifest](https://docs.dreadnode.io/capabilities/manifest/) +- **End-to-end walkthrough** — [quickstart](https://docs.dreadnode.io/capabilities/quickstart/) (~10 minutes from scaffold to running in the TUI) ## Security scanning