Provide embedded documentation

Fixes jlandersen#35

Signed-off-by: azerr <[email protected]>

README.md

@@ -20,12 +20,18 @@ Planned features in no particular order:
 - More administration features
 - Update configs
 
+You might also find useful information in the [Online Documentation](https://github.com/jlandersen/vscode-kafka/blob/master/docs/README.md)
+or you can read this documentation inside your editor (can run in vscode, vscodium, che, theia...) with the command `Open Documentation` available with `Ctrl+Shift+P`:
+
+![Open Documentation](docs/assets/open-doc-cmd.png)
+
 ## Screenshots
-![Screenshot-1](assets/screen-1.png)
 
-![Screenshot-2](assets/screen-2.png)
+![Screenshot-1](docs/assets/screen-1.png)
+
+![Screenshot-2](docs/assets/screen-2.png)
 
-![Screenshot-3](assets/screen-3.png)
+![Screenshot-3](docs/assets/screen-3.png)
 
 ## Producing
 Producing can be done by creating a `.kafka` file. Write simple producers using the following format:
@@ -50,7 +56,7 @@ The log about produced messages is printed in the "Kafka Producer Log" Output vi
 
 Record content can be randomized by injecting mustache-like placeholders of [faker.js properties](https://github.com/Marak/faker.js#api-methods), like ``{{name.lastName}}`` or ``{{random.number}}``. Some randomized properties can be localized via the `kafka.producers.fakerjs.locale` setting.
 
-![Screenshot-4](assets/screen-4.png)
+![Screenshot-4](docs/assets/screen-4.png)
 
 ## Consuming
 Consuming topics can be done by right clicking a topic in the explorer or from the command palette.  Some things to note about consuming:

docs/Consuming.md

@@ -0,0 +1,14 @@
+# Consuming
+
+Consuming topics can be done by right clicking a topic in the explorer or from the command palette.  Some things to note about consuming:
+
+* UTF-8 encoded keys and values only. If data is encoded differently, it will not be pretty.
+* One consumer group is created per topic (may change in the future to just have one for the extension).
+
+Consumers are based on virtual documents, available in the VS Code extension API. A consumer will keep running even if you close the document in the editor. You should make sure to close the consumer explicitly, either via the command palette, the status bar element or the start/stop action button as well. The VS Code API does not support detecting if a virtual document is closed immediately. Instead, the underlying virtual document is automatically closed after two minutes if the document is closed in the editor.
+
+# Preferences
+
+## kafka.consumers.offset
+
+You can configure start offset for new consumers in settings (earliest, latest).

docs/Explorer.md

@@ -0,0 +1,21 @@
+# Explorer
+
+![Screenshot-1](assets/screen-1.png)
+
+![Screenshot-2](assets/screen-2.png)
+
+![Screenshot-3](assets/screen-3.png)
+
+# Preferences
+
+## kafka.explorer.topics.sort
+
+Choose sorting for topics in explorer.
+
+## kafka.explorer.topics.filter
+
+Glob patterns filtering topics out of the Kafka explorer. `*` matches any string, `?` matches a single character.
+
+## kafka.explorer.consumers.filter
+
+Glob patterns filtering consumer groups out of the Kafka explorer. `*` matches any string, `?` matches a single character.

docs/Producing.md

@@ -0,0 +1,35 @@
+# Producing
+
+Producing can be done by creating a `.kafka` file. Write simple producers using the following format:
+
+```
+PRODUCER keyed-message
+topic: my-topic
+key: mykeyq
+record content
+
+###
+
+PRODUCER non-keyed-json-message
+topic: json-events
+{
+    "type": "my_test_event"
+}
+```
+
+For actually producing a single record, click on the "Produce record" link above the PRODUCER line; for producing 10 records, click on "Produce record x 10".
+The log about produced messages is printed in the "Kafka Producer Log" Output view.
+
+# Faker.js
+
+Record content can be randomized by injecting mustache-like placeholders of [faker.js properties](https://github.com/Marak/faker.js#api-methods), like ``{{name.lastName}}`` or ``{{random.number}}``. Some randomized properties can be localized via the `kafka.producers.fakerjs.locale` setting.
+
+![Screenshot-4](assets/screen-4.png)
+
+## kafka.producers.fakerjs.enabled
+
+Enable injection of [faker.js](https://github.com/marak/Faker.js/#api-methods)-randomized data in record templates, using the mustache syntax.
+
+## kafka.producers.fakerjs.locale
+
+[experimental] The locale used to generate [faker.js](https://github.com/marak/Faker.js/#api-methods)-randomized data in record templates.

docs/README.md

@@ -0,0 +1,7 @@
+# VSCode Kafka Documentation
+
+Welcome to the [vscode-kafka](https://github.com/jlandersen/vscode-kafka) documentation.
+
+* [Kafka Explorer](Explorer.md#explorer)
+* [Producing](Producing.md#producing)
+* [Consuming](Consuming.md#consuming)