diff --git a/README.md b/README.md index 8535d34..b1afe8a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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