From 207665a185c30a77813c6aafa0b6e5ccd3f5e882 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Tue, 19 Apr 2022 04:19:23 +0200 Subject: [PATCH] :spiral_notepad: Improve example in README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d7bcff4..4a304cf 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ A configuration manager for Python +\[ [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \] + +## Example + ```python import cfig @@ -17,17 +21,15 @@ if __name__ == "__main__": ``` ```python -from .mycfig import SECRET_KEY +from mypackage.mycfig import SECRET_KEY print(f"My SECRET_KEY is: {SECRET_KEY}") ``` ```console -$ python -m cfig.sample +$ python -m mypackage.mycfig === Configuration === SECRET_KEY → Required, but not set. Secret string used to manage HTTP session tokens. ``` - -\[ [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \] \ No newline at end of file