From e6cfded87dcfc5d2bf62d36bc7b4dbbdeb94b0b8 Mon Sep 17 00:00:00 2001
From: Daniel Tomlinson <dtomlinson@panaetius.co.uk>
Date: Fri, 31 Dec 2021 16:24:56 +0000
Subject: [PATCH] docs: update README.md with script quickstart logging

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 152170d..04e1089 100644
--- a/README.md
+++ b/README.md
@@ -96,6 +96,22 @@ CONFIG = panaetius.Config(
 
 Set variables in the same way as the module above.
 
+#### quickstart logging
+
+```python
+import panaetius
+
+
+def get_logger():
+    logging_dir = pathlib.Path(__file__).parents[0] / "logs"
+    logging_dir.mkdir(parents=True, exist_ok=True)
+
+    CONFIG = panaetius.Config("training_data_into_gcp", skip_header_init=True)
+    panaetius.set_config(CONFIG, "logging.level", "DEBUG")
+    panaetius.set_config(CONFIG, "logging.path", logging_dir)
+    return panaetius.set_logger(CONFIG, panaetius.SimpleLogger(logging_level=CONFIG.logging_level))
+```
+
 ## Utility Functions
 
 ### Squasher