Adds changelog entry and readme note

DataDog · Mar 4, 2024 · c420659 · c420659
1 parent 54046ce
commit c420659
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 ### Added
 - Enforces changelog entries via CI check
+- `payloadtool` binary useful for developers writing new experiments.
 ### Fixed
 - During payload generation, blocks will reliably be filled to the requested amount.
 - During payload generation, block chunks now give more feedback when the

diff --git a/README.md b/README.md
@@ -102,6 +102,14 @@ Logs about lading's operation can be controlled using the standard `RUST_LOG`
 environment variable. eg `RUST_LOG=debug ./lading` will emit logs at `debug`
 and above (ie, `info`, `warn`, `error`).
 
+## Binaries in-tree
+- `lading` -- the main tool capable of generating load, blackholes, observers,
+  etc. Everything discussed above.
+- `captool` -- Useful to inspect the resulting `capture.json` file which
+  contains metrics generated by a lading run.
+- `payloadtool` -- Useful when writing/changing experiments to validate that a
+  specified payload behaves as expected.
+
 ## How to get a build (besides building from source)
 
 ### Binary Releases