Merge pull request #27 from svrnm/add-quickstart-to-readme

Add quickstart to readme for v0.9.0 branch

Author: svrnm

README.md

@@ -26,7 +26,72 @@ This tools can be added to your code as a dependency or executed from the comman
 
 ***
 
-## Support 
+## Quickstart
+
+For a quick start with a basic setup you can download the [latest fat-jar](https://github.com/cisco-open/test-telemetry-generator/releases/download/latest/test-telemetry-generator-otel-proto-0.9.0-fatjar.jar) and [example definitions](./example-definitions/) and put them all into one directory.
+
+You can do all of that in the command line using [curl](https://curl.se/) like the following:
+
+```shell
+mkdir my-test-telemetry
+cd my-test-telemetry
+curl -O https://github.com/cisco-open/test-telemetry-generator/releases/download/latest/test-telemetry-generator-otel-proto-0.9.0-fatjar.jar
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/entity-definition.yaml
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/trace-definition.yaml
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/cli-target-rest.yaml
+```
+
+Your `my-test-telemetry` directory should now contain the following files:
+
+```shell
+$ ls
+cli-target-rest.yaml  entity-definition.yaml  test-telemetry-generator-otel-proto-0.9.0-fatjar.jar  trace-definition.yaml
+```
+
+Next, open the `cli-target-rest.yml` with an editor of your choice and set the `restURL` to your OTLP HTTP endpoint. For example, if you use an [OpenTelemetry
+Collector](https://opentelemetry.io/docs/collector/) running on `localhost` with an `otlp` receiver listening on port `4318`, update your target config to look like the following:
+
+```yaml
+username: "ignored"
+password: "ignored"
+restURL: "http://localhost:4318/v1/traces
+```
+
+Finally, start the test-telemetry-generator:
+
+```shell
+java -jar test-telemetry-generator-otel-proto-0.9.0-fatjar.jar -e entity-definition.yaml -s trace-definition.yaml -t cli-target-rest.yaml
+```
+
+If all goes well, you should see test-telemetry-generator printing out some logs for you:
+
+```text
+...
+10:10:08.525 [main] INFO  i.o.c.g.t.t.dto.Traces - 6jz87jHycn1T7hIE7c7zfKWnsIIBTAwI: Initializing 6 trace trees
+10:10:08.530 [main] INFO  i.o.c.g.t.t.TracesGenerator - 6jz87jHycn1T7hIE7c7zfKWnsIIBTAwI: Initializing 6 trace generator threads
+...
+```
+
+As a next step, you can add metrics and logs as well by downloading some more [example definitions](./example-definitions/):
+
+```shell
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/log-definition.yaml
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/metric-definition.yaml
+```
+
+Start the test-telemetry-generator:
+
+```shell
+java -jar test-telemetry-generator-otel-proto-0.9.0-fatjar.jar -e entity-definition.yaml -s trace-definition.yaml -t cli-target-rest.yaml -l log-definition.yaml -m metric-definition.yaml
+```
+
+Again, you will see test-telemetry-generator printing out some logs for you and you should also see traces, metrics and logs flowing into your OTLP endpoint.
+
+You now have a working setup from which you can build your own telemetry test environment. Update the definition files to your needs and read the [wiki](https://github.com/cisco-open/test-telemetry-generator/wiki) to learn more.
+
+***
+
+## Support
 
 We are continuously improving the tool and adding more feature support. Please see the [open issues](https://github.com/cisco-open/test-telemetry-generator/issues) to see the list of planned items and feel free to open a new issue in case something that you'd like to see is missing.
 
@@ -35,8 +100,8 @@ We are continuously improving the tool and adding more feature support. Please s
 ## Contributors
 
 Built with :heart: by and with the support of:  
+
 * [Severin Neumann](https://github.com/svrnm)
 * [Ashish Tyagi](https://github.com/ashish-tyagi)
 * [Aarushi Singh](https://github.com/AarushiSingh09)
 * [Manpreet Singh](https://github.com/preet-dev)
-