Skip to content

Commit

Permalink
Merge pull request #3 from xPolar/patch-1
Browse files Browse the repository at this point in the history
changes to readme
  • Loading branch information
KAJdev authored Apr 15, 2022
2 parents 7c3181e + 8f33218 commit c659d6d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# snowfin
An async discord http interactions framework built on top of Sanic
An async discord http interactions framework built on top of Sanic.

## Installing
for now just install the package through pip via github
For now just install the package through PIP via GitHub
> Please note that the library requires at least python 3.10
```sh
# Unix based
pip3 install git+https://github.com/kajdev/snowfin
Expand All @@ -11,7 +12,7 @@ pip3 install git+https://github.com/kajdev/snowfin
py -m pip install git+https://github.com/kajdev/snowfin
```

## Example
## Examples

### Simple slash command
```python
Expand Down Expand Up @@ -52,7 +53,7 @@ async def on_slash_defer(context: Interaction):
bot.run("0.0.0.0", 80, debug=True)
```

you can see more examples in [/examples](https://github.com/KAJdev/snowfin/tree/main/examples)
You can see more examples [here](https://github.com/KAJdev/snowfin/tree/main/examples)

## Links

Expand Down

0 comments on commit c659d6d

Please sign in to comment.