diff --git a/README.md b/README.md index d1c058c..4606bcd 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,33 @@ Please visit the framework at the link below and good hunting! https://osintframework.com ### Legend -(T) - Indicates a link to a tool that must be installed and run locally -(D) - Google Dork, for more information: Google Hacking -(R) - Requires registration -(M) - Indicates a URL that contains the search term and the URL itself must be edited manually + +#### Name Markers +(T) - Indicates a link to a tool that must be installed and run locally +(D) - Google Dork, for more information: Google Hacking +(R) - Requires registration +(M) - Indicates a URL that contains the search term and the URL itself must be edited manually + +#### Tool Metadata Fields +Each tool entry in `arf.json` can include structured metadata beyond the name and URL: + +| Field | Type | Description | +|-------|------|-------------| +| `description` | string | What the tool does | +| `status` | string | `live`, `degraded`, `down`, or `deprecated` | +| `pricing` | string | `free`, `freemium`, or `paid` | +| `bestFor` | string | Primary use case in one line | +| `input` | string | What the tool takes as input | +| `output` | string | What the tool returns | +| `opsec` | string | `passive` or `active` | +| `opsecNote` | string | Operational security considerations | +| `localInstall` | boolean | Corresponds to `(T)` marker | +| `googleDork` | boolean | Corresponds to `(D)` marker | +| `registration` | boolean | Corresponds to `(R)` marker | +| `editUrl` | boolean | Corresponds to `(M)` marker | +| `api` | boolean | Whether the tool offers an API | +| `invitationOnly` | boolean | Whether access requires an invitation | +| `deprecated` | boolean | Whether the tool is deprecated | ### For Update Notifications Follow me on Twitter: @jnordine - https://twitter.com/jnordine @@ -26,23 +49,37 @@ Feedback or new tool suggestions are extremely welcome! Please feel free to sub ### Contribute with a GitHub Pull Request For new resources, please ensure that the site is available for public and free use. -