diff --git a/README.md b/README.md index 7a3ad55..ecdfcc9 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,16 @@ A lightweight REST load testing tool with rubust support for different verbs, token auth, and performance reports. -Example using source: +## Example using source: 1. `go run main.go -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere` -Example using binary: +## Example using binary: 1. go build 2. `./loadr -rate=20 -max=100 -url=https://api.example.com/resource -type=POST -json=./data.json -token=YourBearerTokenHere` -Flags: +## Flags: - `-rate`: Number of requests per second. Default is 10. - `-max`: Maximum number of requests to send. Must be a non-zero integer. Default is 50. @@ -19,3 +19,7 @@ Flags: - `-type`: Type of HTTP request. Can be GET, POST, PUT, DELETE, etc. Default is "GET". - `-json`: Path to the JSON file with request data. If not provided, no data is sent with the requests. - `-token`: Bearer token for authorization. If not provided, no Authorization header is sent with the requests. + +## Reports + +Reports are logged at the end of a test run. They are also saved in a directory called `.reports`. All reports are saved as text files with `YYYYMMdd-HHmmss` time format names.