Skip to content

Commit ed238d8

Browse files
committed
Fixes in README
1 parent d39c20c commit ed238d8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# xk6-passkeys
22

3-
A k6 extension for testing passkey backends ("WebAuthn servers"). With this extension, you can load test your passkey registration and login flows.
3+
A k6 extension for load-testing passkey backends ("WebAuthn servers"). With this extension, you can load-test your passkey registration and login flows.
44

55
## Prerequisites
66

@@ -23,24 +23,24 @@ This will create a `k6` binary in the current directory with the extension compi
2323

2424
## Examples
2525

26-
We have implemented two example load tests in the `examples` directory: one for registration and one for login.
26+
We have implemented two example load-tests in the `examples` directory: one for registration and one for login.
2727

28-
Since a passkeys backend is required for testing, we provide a sample backend for load testing. To start the backend, execute the following commands:
28+
Since a passkeys backend is required for load-testing, we provide a sample backend for load-testing. To start the backend, execute the following commands:
2929

3030
```bash
3131
docker build -t passkeys-backend examples/backend
3232
docker run -p 8080:8080 passkeys-backend
3333
```
3434

35-
🚨 **The backend has been implemented solely for testing purposes. It has not been reviewed, secured, thoroughly tested, nor does it adhere to best practices.**
35+
🚨 **The backend has been implemented solely for load-testing purposes. It has not been reviewed, secured, thoroughly tested, nor does it adhere to best practices.**
3636

37-
To load test the registration flow, run the following command (**in a different terminal**):
37+
To load-test the registration flow, run the following command (**in a different terminal**):
3838

3939
```bash
4040
./k6 run examples/registration.js
4141
```
4242

43-
To load test the login flow, run the following command (**in a different terminal**):
43+
To load-test the login flow, run the following command (**in a different terminal**):
4444

4545
```bash
4646
./k6 run examples/login.js

0 commit comments

Comments
 (0)