Merge c989c1af8a into dc5779f1bc

README.md

@@ -1,35 +1,15 @@
+<div align="center"> 
+
+![](.media/icon-128x128_round.png)
+
 # cfig
 
-A configuration manager for Python 
+Configuration helper for Python 
 
-\[ [**Example**](https://github.com/Steffo99/cfig/tree/main/cfig/sample) | [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \]
+</div>
 
-```python
+## Links
-import cfig
 
-config = cfig.Configuration()
+[![PyPI](https://img.shields.io/pypi/v/cfig)](https://pypi.org/project/cfig)
 
-@config.required()
+[![Documentation](https://img.shields.io/readthedocs/cfig)](https://cfig.readthedocs.io/en/latest/)
-def SECRET_KEY(val: str) -> str:
-    """Secret string used to manage HTTP session tokens."""
-    return val
-
-if __name__ == "__main__":
-    config.cli()
-```
-
-```python
-from mypackage.mycfig import SECRET_KEY
-
-print(f"My SECRET_KEY is: {SECRET_KEY}")
-```
-
-```console
-$ python -m mypackage.mycfig
-===== Configuration =====
-
-SECRET_KEY    → Required, but not set.
-Secret string used to manage HTTP session tokens.
-
-===== End =====
-```