diff --git a/README.md b/README.md index ab1fc2ca9c90df4cec5ff000811c0bcbb81f9e20..88ca4e8f122e11914f5956582ea718740a5a9bb7 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,19 @@ Holi Load Testing is implemented using [Grafana k6](https://k6.io/docs/). +## Development + +To build and run k6 with extensions for local development, follow these steps: + +1. Install [Go](https://go.dev/doc/install) +2. Download xk6: `go install go.k6.io/xk6/cmd/xk6@latest` +3. Build the k6 binary with the xk6-dashboard extension: `xk6 build --with github.com/szkiba/xk6-dashboard@latest` +4. Execute k6: `./k6 run --out dashboard=open scripts/main.js` + ## Installation: +### Docker + To run Holi Load Testing locally, follow these steps: 1. Clone the repository. @@ -17,4 +28,4 @@ To run Holi Load Testing locally, follow these steps: / \/ \ | ( / ‾‾\ / \ | |\ \ | (‾) | / __________ \ |__| \__\ \_____/ .io -``` \ No newline at end of file +```