From aa1f3cb41e7e1262e6221ee3913a053037265d85 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Tue, 19 Apr 2022 04:16:23 +0200
Subject: [PATCH] :spiral_notepad: Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b04d2c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# cfig
+
+A configuration manager for Python 
+
+```python
+import cfig
+
+config = cfig.Configuration()
+
+@config.required()
+def SECRET_KEY(val: str) -> str:
+    """Secret string used to manage tokens."""
+    return val
+
+if __name__ == "__main__":
+    config.cli()
+```
+
+```console
+$ python -m cfig.sample
+=== Configuration ===
+
+SECRET_KEY    → Required, but not set.
+Secret string used to manage HTTP session tokens.
+```
+
+\[ [**Documentation**]() | [**PyPI**](https://pypi.org/project/cfig/) \]
\ No newline at end of file