-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,22 @@ | ||
# mafic | ||
|
||
A properly typehinted lavalink client for discord.py, nextcord, disnake and py-cord. | ||
|
||
## Installation | ||
|
||
Mafic, as it is in alpha, does not have a stable release on PyPI. To install it, you must use the following command: | ||
|
||
```bash | ||
pip install git+https://github.com/ooliver1/mafic | ||
``` | ||
|
||
> **Note** | ||
> Use `python -m`, `py -m`, `python3 -m` or similar if that is how you install packages. | ||
> Generally windows uses `py -m pip` and linux uses `python3 -m pip` | ||
## Usage | ||
|
||
> **Warning** | ||
> Mafic is in public alpha, do not use in production. | ||
There are no examples as of now, neither are there any docs just yet, for development purposes, `test_bot` contains the start of a bot using mafic. |