diff --git a/README.md b/README.md index ccf5902..04f42c7 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,4 @@ pip install git+https://github.com/ooliver1/mafic > **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. +There are no examples as of now. For development purposes, `test_bot` contains the start of a bot using mafic. diff --git a/docs/index.rst b/docs/index.rst index c2628ff..1242d26 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,8 @@ Welcome to mafic's documentation! ================================= +Mafic is a properly typehinted lavalink client for discord.py, nextcord, disnake and py-cord. + .. toctree:: :maxdepth: 2 :caption: Contents: diff --git a/docs/installing.rst b/docs/installing.rst index 4f63213..734d1e0 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -13,15 +13,18 @@ Mafic is on PyPI, so it can be installed via pip. he command varies depending on your system, generally use what you used to install your Discord library. +.. warning:: + + Mafic is not on PyPI as it is not stable. .. tab:: Windows .. code-block:: powershell - > py -m pip install mafic + > py -m pip install git+https://github.com/ooliver1/mafic .. tab:: MacOS / Linux .. code-block:: sh - $ python3 -m pip install mafic + $ python3 -m pip install git+https://github.com/ooliver1/mafic