Skip to content

Commit 6749f1c

Browse files
committed
refactor README for clarity
1 parent 2da9306 commit 6749f1c

1 file changed

Lines changed: 9 additions & 13 deletions

File tree

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,15 @@
66

77
## Quick Start
88

9-
Requires [Docker](https://www.docker.com/) and the `janus-cli` binary.
9+
Requires [Docker](https://www.docker.com/) and the `janus-cli` binary built for your operating system.
1010

1111
```bash
1212
git clone https://github.com/SpecterOps/Janus/ && cd Janus
1313
make cli
14-
cp Config/janus.example.yml Config/janus.yml
14+
cp Config/janus.example.yml Config/janus.yml # set source, redaction settings, etc.
1515
./janus-cli run
1616
```
1717

18-
On Windows, `make cli` produces `janus-cli.exe` in the repo root.
19-
20-
On Linux, if `docker info` fails with permission denied on the Docker socket, see [docs/FAQ.md](docs/FAQ.md#docker-socket-permission-denied) (docker group and session).
21-
2218
## Usage
2319

2420
```bash
@@ -53,12 +49,6 @@ On Linux, if `docker info` fails with permission denied on the Docker socket, se
5349
</a>
5450
</p>
5551

56-
## Privacy
57-
58-
Janus runs analysis locally and does **not** use LLMs or external services for normalized operation data.
59-
60-
Retention policies (`output_rule` and `arguments_rule`) control what normalized content is written to disk. See [docs/architecture.md — Privacy](docs/architecture.md#privacy).
61-
6252
## Analyzers
6353

6454
| Analyzer | What it answers |
@@ -77,13 +67,19 @@ Retention policies (`output_rule` and `arguments_rule`) control what normalized
7767

7868
`parameter-entropy` works best when you tune `Config/analyzer_registry.yml` to your own workflows. The current `upload` tuning reflects our observed data and should be treated as a starting point, not a universal baseline.
7969

70+
## Privacy
71+
72+
Janus runs analysis locally and does **not** use LLMs or external services for normalized operation data.
73+
74+
Retention policies (`output_rule` and `arguments_rule`) control what normalized content is written to disk. See [docs/architecture.md — Privacy](docs/architecture.md#privacy).
75+
8076
## Outputs
8177

8278
- `report.html` - visual HTML report
8379
- `bundle.json` - versioned JSON metadata for automation and downstream tooling
8480
- `events.ndjson` - normalized event stream for debugging, replay, and testing
8581

86-
For the full normalized event model and architecture notes, see [docs/architecture.md](docs/architecture.md).
82+
For the full normalized event model and architecture notes, see docs below.
8783

8884
## Docs
8985

0 commit comments

Comments
 (0)