From ebe74c7400a8dd024493c8dc56b6c67a5c0d6dcb Mon Sep 17 00:00:00 2001 From: Ming Date: Mon, 6 Jan 2020 12:16:55 -0500 Subject: [PATCH] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 647a430..86311b8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Beam is a http based streaming and queueing system that is backed up by Apache P 1. Data can be sent to Pulsar via an HTTP POST method as a producer. 2. To consume the data, data can be pushed to a webhook. -3. To consume the data, data can be retrieved by an HTTP GET method. +3. A webhook can reply processed message, in the response body, back to another Pulsar topic via Pulsar Beam. The development is in an early stage. Please email `contact@kafkaesque.io` for any inquiry or demo. Opening an issue and PR are welcomed! @@ -30,10 +30,9 @@ These HTTP headers are required to map to Pulsar topic. 3. PulsarUrl -> a fully qualified pulsar or pulsar+ssl URL is required ### Webhook registration +Webhook registration is done via REST API backed by MongoDB. -In the current prototype, webhook registration is specified in ./config/prototype-db/default.json. - -The registration will be moved to a permenant database soon. +TODO: add REST API document. ### Sink source @@ -84,4 +83,4 @@ This is an example of file based user Pulsar topic configurations. ``` $ sudo docker run -d -it -v /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem:/etc/ssl/certs/ca-bundle.crt -v /home/ming/go/src/github.com/pulsar-beam/config:/root/config -p 3000:3000 --name=pbeam-server pulsar-beam -``` \ No newline at end of file +```