Skip to content

Commit

Permalink
chore: Minor readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
oakhan3 committed Aug 4, 2023
1 parent 1ccad44 commit db1a189
Show file tree
Hide file tree
Showing 4 changed files with 406 additions and 383 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
fail-fast: false
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
poetry-version: [1.1.8]
poetry-version: [1.4.2]

steps:
- uses: actions/checkout@v2
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ list_of_stuff:

```python
# app.py
from configly import Config


config = Config.from_yaml('config.yml')

print(config.foo.bar)
Expand Down Expand Up @@ -108,6 +111,9 @@ can be loaded. It's largely unimportant what the input format is, but we started
that deserialize into at least `str`, `float`, `int`, `bool` and `None` types.

```python
from configly import Config


# Currently supported input formats.
config = Config.from_yaml('config.yml')
config = Config.from_json('config.json')
Expand Down Expand Up @@ -146,6 +152,9 @@ Now that you've loaded the above configuration:

```python
# app.py
from configly import Config


config = Config.from_yaml('config.yml')

# You can access namespaced config using dot access
Expand Down
Loading

0 comments on commit db1a189

Please sign in to comment.