Skip to content

Commit

Permalink
docs: add basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ooliver1 committed Oct 25, 2022
1 parent db80675 commit 19e8606
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
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.

0 comments on commit 19e8606

Please sign in to comment.