Skip to content

Commit 5e71b58

Browse files
committed
add list shapes to readme.md
1 parent 83d59e0 commit 5e71b58

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,13 @@ Other available shapes are:
170170
- `step` - The load will increase in steps. `--spawn-rate` flag is required to specify the step size. The number of steps will be calculated based on `--users` divided by `--spawn-rate`. The duration of each step will be calculated based on `--test-time` divided by the number of steps.
171171
- `spike` - The load will run in a spike pattern. The load will ramp up to 10% of the total users for 40% of the test duration and then spike to 100% of the total users as specified by `--users` for 20% of test duration and then reduce back to 10% of total users until the test duration is over.
172172

173+
Use the following command to list all shapes in chainbench/shapes
174+
```shell
175+
chainbench list shapes
176+
```
177+
You may add your own custom shapes by copying one of the existing shapes in chainbench/shapes and modifying them to fit your requirements.
178+
179+
173180
### Test Data Size
174181
You may specify the test data size using the `--size` flag. This will determine how much data is used in the test.
175182
Take note that larger data size will result in longer test data generation time before the test starts.

0 commit comments

Comments
 (0)