Added documentation, addd plugin to sample app

2021-01-09 21:56:54 +02:00
parent c139285492
commit 16cd6b8e25
12 changed files with 152 additions and 13 deletions
@@ -0,0 +1,24 @@
+# Kafka Backend
+
+This is the backend part of the Kafka plugin. It responds to Kafka requests from the frontend.
+
+## Configuration
+
+This configures how to connect to the brokers in your Kafka cluster.
+
+### clientId
+
+The name of the client to use when connecting to the cluster.
+
+### brokers
+
+A list of the brokers' hostnames and ports to connect to.
+
+Example:
+
+```yaml
+kafka:
+  clientId: backstage
+  brokers:
+    - localhost:9092
+```
@@ -1,6 +1,6 @@
 {
  "name": "@backstage/plugin-kafka-backend",
-  "version": "0.1.1",
+  "version": "0.1.0",
  "main": "src/index.ts",
  "types": "src/index.ts",
  "license": "Apache-2.0",