Added readme.

2024-12-05 08:22:54 +01:00 · 2024-12-05 08:22:54 +01:00 · 3c50c4a2c5
commit 3c50c4a2c5
parent c8d17169a4
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ 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")
+```