From 1790071741207de13330ba75d7bf090106290d72 Mon Sep 17 00:00:00 2001
From: Daniel Tomlinson <dtomlinson@panaetius.co.uk>
Date: Wed, 29 Dec 2021 04:46:10 +0000
Subject: [PATCH] docs: update README.md with script boilerplate

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

diff --git a/README.md b/README.md
index f933352..d04ccb0 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,23 @@ import tembo.cli
 tembo.cli.CONFIG
 ```
 
+### Script
+
+Create `./config/config.yml` in the same directory as the script.
+
+In the script initialise a `CONFIG` object:
+
+```python
+import pathlib
+
+import panaetius
+
+CONFIG = panaetius.Config(
+    "teenagers_scraper", str(pathlib.Path(__file__).parents[0] / ".config"), skip_header_init=True
+)
+```
+
+Set variables in the same way as the module above.
 
 ## Utility Functions