Merge pull request #74 from PySATL/future/cli

feat: add start example

Author: f1i3g3

README.md

@@ -1,4 +1,4 @@
-# statistic-test
+# statistic-test
 
 [![Freqtrade CI](https://github.com/PySATL/pysatl-experiment/workflows/PySATL%20CI/badge.svg)](https://github.com/PySATL/pysatl-experiment/actions)
 [![Coverage Status](https://coveralls.io/repos/github/PySATL/pysatl-experiment/badge.svg?branch=main)](https://coveralls.io/github/PySATL/pysatl-experiment?branch=main)
@@ -116,3 +116,55 @@ Starting manually:
 ```shell
 poetry run pre-commit run --all-files --color always --verbose --show-diff-on-failure
 ```
+
+### Quick Start example
+
+1. Creating of experiment.
+
+```shell
+poetry run experiment create NAME
+```
+
+2. Set the experiment type value. Experiment types: critical_value, power, time_complexity.
+
+```shell
+poetry run experiment configure NAME experiment-type critical_value 
+```
+
+3. Setting the hypothesis value. Experiment types: normal, exponential, weibull.
+
+```shell
+poetry run experiment configure NAME hypothesis normal
+```
+
+4. Set the sample size value. (min = 10)
+
+```shell
+run experiment configure NAME sample-sizes 23
+```
+
+5. Setting the value of the Monte Carlo number. (min = 100)
+
+```shell
+poetry run experiment configure NAME monte-carlo-count 154
+```
+
+6. Setting the significance levels.
+
+```shell
+poetry run experiment configure NAME significance-levels 0.05 0.01
+```
+
+7. Setting the file name for connecting the storage.
+
+```shell
+experiment configure NAME storage-connection FILENAME 
+```
+
+8. Running the experiment.
+
+```shell
+poetry run experiment build-and-run NAME 
+```
+
+Parameters experiment-type, hypothesis, sample-sizes, monte-carlo-count, significance-levels, storage-connection required to set values.