diff --git a/README.md b/README.md index d93ee18..9c6b1b5 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,15 @@ Built on Kubernetes with scale in mind, our goal with Nemesis was to create a ce Nemesis aims to automate a number of repetitive tasks operators encounter on engagements, empower operators’ analytic capabilities and collective knowledge, and create structured and unstructured data stores of as much operational data as possible to help guide future research and facilitate offensive data analysis. -# Setup / Installation +## Setup / Installation Follow the [quickstart guide](docs/quickstart.md) Or see the full [setup instructions](docs/setup.md) -# Usage +## Usage See the [Nemesis Usage Guide](docs/usage_guide.md). -# Contributing / Development Environment Setup +## Contributing / Development Environment Setup See [development.md](./docs/development.md) ## Further Reading @@ -54,7 +54,7 @@ See [development.md](./docs/development.md) | *On (Structured) Data* | Jul 26, 2023 | https://posts.specterops.io/on-structured-data-707b7d9876c6 | -# Acknowledgments +## Acknowledgments Nemesis is built on large chunk of other people's work. Throughout the codebase we've provided citations, references, and applicable licenses for anything used or adapted from public sources. If we're forgotten proper credit anywhere, please let us know or submit a pull request! diff --git a/docs/index.md b/docs/index.md index 88d794f..43298b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,7 +25,7 @@
-# Overview +## Overview Nemesis is an offensive data enrichment pipeline and operator support system. @@ -33,13 +33,13 @@ Built on Kubernetes with scale in mind, our goal with Nemesis was to create a ce Nemesis aims to automate a number of repetitive tasks operators encounter on engagements, empower operators’ analytic capabilities and collective knowledge, and create structured and unstructured data stores of as much operational data as possible to help guide future research and facilitate offensive data analysis. -# Setup / Installation +## Setup / Installation See the [setup instructions](setup.md). -# Usage +## Usage See the [Nemesis Usage Guide](usage_guide.md). -# Contributing / Development Environment Setup +## Contributing / Development Environment Setup See [development.md](development.md) ## Further Reading @@ -52,7 +52,7 @@ See [development.md](development.md) | *On (Structured) Data* | Jul 26, 2023 | https://posts.specterops.io/on-structured-data-707b7d9876c6 | -# Acknowledgments +## Acknowledgments Nemesis is built on large chunk of other people's work. Throughout the codebase we've provided citations, references, and applicable licenses for anything used or adapted from public sources. If we're forgotten proper credit anywhere, please let us know or submit a pull request!