Skip to content

Commit

Permalink
Update index.md to no longer use the image. This will make it so the …
Browse files Browse the repository at this point in the history
…documentation page can be used for PyPi as well as github pages.
  • Loading branch information
Isaak-Malers committed Feb 28, 2024
1 parent ff34542 commit 267c4e6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,21 @@

clifunction makes building and maintaining command line utilities easier than ever by using the annotations included in modern python versions, Here is a quick look:

![Example Usage](./Example.png)
How your code looks:
```python
@cli_function
def migrate_data_base(*, start_version: int = 0, end_version: int = 3):
"""
Runs DB migrations.
"""
print(f"Migrating DB from {start_version} to {end_version}")
```
How you invoke that function:
```commandline
isaak@laptop:/mnt/c/Users/isaak/dev/clifunction$ python3 Example.py migrate_data_base
migrate_data_base: {}
Migrating DB from 0 to 3
```


### Getting Started
Expand Down

0 comments on commit 267c4e6

Please sign in to comment.