From 3934c1ed8439e44b9ddaa7f8695a55a35a9f59f4 Mon Sep 17 00:00:00 2001 From: Martin Hutchinson Date: Thu, 25 Apr 2024 12:14:54 +0100 Subject: [PATCH] Improve docs --- hammer/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/hammer/README.md b/hammer/README.md index 2af5c67..7772d03 100644 --- a/hammer/README.md +++ b/hammer/README.md @@ -1,5 +1,9 @@ # Hammer: A load testing tool for serverless logs +This hammer sets up read and (optionally) write traffic to a log to test correctness and performance under load. + +If write traffic is enabled, then the target log must support `POST` requests to a `/add` path. + ## Usage As an example for testing the serving capabilities of the Armored Witness CI log: @@ -10,4 +14,5 @@ SERVERLESS_LOG_PUBLIC_KEY=transparency.dev-aw-ftlog-ci-2+f77c6276+AZXqiaARpwF4Mo --origin="transparency.dev/armored-witness/firmware_transparency/ci/2" ``` -The process can be killed with . +This will start a text-based UI in the terminal that shows the current status, logs, and supports increasing/decreasing read and write traffic. +The process can be killed with ``.