update cli readme

elasticrash · Jul 10, 2021 · 36e334f · 36e334f
1 parent 0953959
commit 36e334f
Showing 1 changed file with 14 additions and 3 deletions.
diff --git 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 <configuration>               sets a custom configuration name and path relative to this location
+    -d <datastore>                   Sets the type of the datastore to generate values. By default executes the entire
+                                     configuration
+    -s, --spawn-size <spawn-size>    Set the number of rows per table to be generated
 ```
 example
 ```
-spawnflakes.exe 22
+spawnflakes.exe -s 4 -c ..\config.json
 ```