diff --git a/README.md b/README.md index 8132b17..816e6e8 100644 --- a/README.md +++ b/README.md @@ -13,35 +13,3 @@ Configuration helper for Python [![PyPI](https://img.shields.io/pypi/v/cfig)](https://pypi.org/project/cfig) [![Documentation](https://img.shields.io/readthedocs/cfig)](https://cfig.readthedocs.io/en/latest/) - -## Example - -```python -import cfig - -config = cfig.Configuration() - -@config.required() -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 ===== -```