From 1d028af70834f56fd4ebc02ff3f79c68b0d56f24 Mon Sep 17 00:00:00 2001 From: Vladan Popovic Date: Sun, 6 Sep 2020 11:33:20 +0200 Subject: [PATCH] Explain a bit more what the application does --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index fbfb192..7ff289b 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,11 @@ Website checker demo CHWEB is a website checking tool. +It sends HTTP requests to sites with the intent to check their status / +availibility, and if the ``regex`` param is specified, it runs it against the +response body. The retreived status check is sent to a Kafka topic. When +read by the consumer, the status check is written in a PostgreSQL database. + ATM in its very early stages meant to demo `aiven `_'s platform, using their `kafka `_ and `postgresql `_ services.