From 3c50c4a2c532ccb964a2522d523f6f507d314e98 Mon Sep 17 00:00:00 2001
From: retoor <retoor@molodetz.nl>
Date: Thu, 5 Dec 2024 08:22:54 +0100
Subject: [PATCH] Added readme.

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..18e1437
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Mololog
+
+Mololog is a logging framework for python applications.
+
+It contains three applications:
+ - mololog.serve
+ - mololog.test
+ - mololog.bench
+
+## Running mololog server
+```
+mololog.serve --host=127.0.0.1 --port=3016 --db=mololog.db
+```
+## Implementation of logger in application
+```
+from mololog.client import patch
+patch("https://your-logging-server.nl")
+```