From ecd2bbb35c10d07f9195454c77f634d3bc807fd2 Mon Sep 17 00:00:00 2001
From: Jens Reimann <jreimann@redhat.com>
Date: Mon, 14 Oct 2019 13:59:41 +0200
Subject: [PATCH] Add some more description

---
 README.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 6c693cd..2842fe0 100644
--- a/README.md
+++ b/README.md
@@ -45,13 +45,13 @@ metadata:
   namespace: iot-simulator
 spec:
   endpoint:
-    messaging:
+    messaging: # Messaging endpoint information
       user: foo
       password: bar
       host: messaging.host.hono.svc
       port: '5671'
       caCertificate: ''
-    registry:
+    registry: # Device registry endpoint
       url: 'https://your-device-registry'
       apiVersion: LEGACY # or V1
     adapters:
@@ -71,7 +71,7 @@ metadata:
   name: consumer1
   namespace: iot-simulator
 spec:
-  simulator: hono1
+  simulator: hono1 # metadata.name of the Simulator resource
   tenant: myapp1.iot
   type: telemetry
   replicas: 1
@@ -86,10 +86,10 @@ metadata:
   name: producer1
   namespace: iot-simulator
 spec:
-  simulator: hono1
+  simulator: hono1 # metadata.name of the Simulator resource
   tenant: myapp1.iot
-  type: telemetry
-  protocol: http
+  type: telemetry # or 'event'
+  protocol: http # or 'mqtt'
   replicas: 1
   numberOfDevices: 10
 ~~~