From b2a88d9a78e96bd969f4bc5ada91878d77e1204e Mon Sep 17 00:00:00 2001
From: retoor <retoor@molodetz.nl>
Date: Wed, 27 Nov 2024 15:38:07 +0100
Subject: [PATCH] Updated readme

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..952427b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Zhurnal
+
+Application for running and monitoring multiple applications.
+The monitoring goes trough web.
+The web interface will show life updates of stdout and stderr of configured applications.
+
+## Instalation
+1. Run `make`. This will build envionment and will install the application.
+2. Run Zhurnal with the commands as parameters followed by the host / port to serve on. `./.venv/bin/zhurnal "ping google.nl" "ping google.nl" --host=127.0.0.1 --port=8081`
+
+## Todo
+1. Optional Basic Auth configurable trough command line.
+2. Process filtering in web interface by pressing a digit. Escape to show all processes.