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