diff --git a/cli/README.md b/cli/README.md index ec85f5d..e089e73 100644 --- a/cli/README.md +++ b/cli/README.md @@ -2,11 +2,22 @@ This is the cli tool the loyal companion of the spanwflake libary -## Running the tool +## USAGE + ``` -spawnflakes.exe number_of_records_to_be_generated +spawnflakes.exe [OPTIONS] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -c sets a custom configuration name and path relative to this location + -d Sets the type of the datastore to generate values. By default executes the entire + configuration + -s, --spawn-size Set the number of rows per table to be generated ``` example ``` -spawnflakes.exe 22 +spawnflakes.exe -s 4 -c ..\config.json ``` \ No newline at end of file