diff --git a/README.md b/README.md new file mode 100644 index 00000000..5e2d423a --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +
+ + +![Logo](https://raw.githubusercontent.com/PythonistaGuild/Wavelink/master/logo.png) + +![Python Version](https://img.shields.io/pypi/pyversions/Wavelink) +[![PyPI - Version](https://img.shields.io/pypi/v/Wavelink)](https://pypi.org/project/wavelink/) +[![Github License](https://img.shields.io/github/license/PythonistaGuild/Wavelink)](LICENSE) +[![Lavalink Version](https://img.shields.io/badge/Lavalink-v4.0%2B-blue?color=%23FB7713)](https://lavalink.dev) +![Lavalink Plugins](https://img.shields.io/badge/Lavalink_Plugins-Native_Support-blue?color=%2373D673) +[![Discord](https://img.shields.io/discord/490948346773635102?logo=discord&logoColor=%23FFF&label=Pythonista&labelColor=%235865F2&color=%232B2D31)](https://discord.gg/RAKc3HF) + + +
+ + +Wavelink is a robust and powerful Lavalink wrapper for [Discord.py](https://github.com/Rapptz/discord.py) +Wavelink features a fully asynchronous API that's intuitive and easy to use. + + +# Migrating from Version 2 to Version 3: + +[Migrating Guide](https://wavelink.dev/en/latest/migrating.html) + + +### Features + +- Full asynchronous design. +- Lavalink v4+ Supported with REST API. +- discord.py v2.0.0+ Support. +- Advanced AutoPlay and track recommendations for continuous play. +- Object orientated design with stateful objects and payloads. +- Fully annotated and complies with Pyright strict typing. + + +## Getting Started + +**See Examples:** [Examples](https://github.com/PythonistaGuild/Wavelink/tree/main/examples) + +**Lavalink:** [GitHub](https://github.com/lavalink-devs/Lavalink/releases), [Webpage](https://lavalink.dev) + + +## Documentation + +[Official Documentation](https://wavelink.dev/en/latest) + +## Support + +For support using WaveLink, please join the official [Support Server](https://discord.gg/RAKc3HF) on +[Discord](https://discordapp.com) + +[![Discord Banner](https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2)](https://discord.gg/RAKc3HF) + + +## Installation + +**WaveLink 3 requires Python 3.10+** + +**Windows** + + +```sh +py -3.10 -m pip install -U wavelink +``` + +**Linux** + +```sh +python3.10 -m pip install -U wavelink +``` + +**Virtual Environments** + +```sh +pip install -U wavelink +``` + + +## Lavalink + +Wavelink **3** requires **Lavalink v4**. +See: [Lavalink](https://github.com/lavalink-devs/Lavalink/releases) + +For spotify support, simply install and use [LavaSrc](https://github.com/topi314/LavaSrc) with your `wavelink.Playable` + + +### Notes + +- Wavelink **3** is compatible with Lavalink **v4+**. +- Wavelink has built in support for Lavalink Plugins including LavaSrc and SponsorBlock. +- Wavelink is fully typed in compliance with Pyright Strict, though some nuances remain between discord.py and wavelink. diff --git a/README.rst b/README.rst deleted file mode 100644 index 2c39b902..00000000 --- a/README.rst +++ /dev/null @@ -1,103 +0,0 @@ -.. image:: https://raw.githubusercontent.com/PythonistaGuild/Wavelink/master/logo.png - - -.. image:: https://img.shields.io/badge/Python-3.10%20%7C%203.11-blue.svg - :target: https://www.python.org - - -.. image:: https://img.shields.io/github/license/PythonistaGuild/Wavelink.svg - :target: LICENSE - - -.. image:: https://img.shields.io/discord/490948346773635102?color=%237289DA&label=Pythonista&logo=discord&logoColor=white - :target: https://discord.gg/RAKc3HF - - -.. image:: https://img.shields.io/pypi/dm/Wavelink?color=black - :target: https://pypi.org/project/Wavelink - :alt: PyPI - Downloads - - -.. image:: https://img.shields.io/maintenance/yes/2023?color=pink&style=for-the-badge - :target: https://github.com/PythonistaGuild/Wavelink/commits/main - :alt: Maintenance - - - -Wavelink is a robust and powerful Lavalink wrapper for `Discord.py `_. -Wavelink features a fully asynchronous API that's intuitive and easy to use. - - -Migrating from Version 2 to Version 3: -###################################### - -`Migrating Guide `_ - - -**Features:** - -- Full asynchronous design. -- Lavalink v4+ Supported with REST API. -- discord.py v2.0.0+ Support. -- Advanced AutoPlay and track recommendations for continuous play. -- Object orientated design with stateful objects and payloads. -- Fully annotated and complies with Pyright strict typing. - - -Documentation -------------- -`Official Documentation `_ - -Support -------- -For support using WaveLink, please join the official `support server -`_ on `Discord `_. - -.. image:: https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2 - :target: https://discord.gg/RAKc3HF - - -Installation ------------- -**WaveLink 3 requires Python 3.10+** - -**Windows** - -.. code:: sh - - py -3.10 -m pip install -U wavelink - -**Linux** - -.. code:: sh - - python3.10 -m pip install -U wavelink - -**Virtual Environments** - -.. code:: sh - - pip install -U wavelink - - -Getting Started ---------------- - -**See Examples:** `Examples `_ - - -Lavalink --------- - -Wavelink **3** requires **Lavalink v4**. -See: `Lavalink `_ - -For spotify support, simply install and use `LavaSrc `_ with your `wavelink.Playable` - - -Notes ------ - -- Wavelink **3** is compatible with Lavalink **v4+**. -- Wavelink has built in support for Lavalink Plugins including LavaSrc and SponsorBlock. -- Wavelink is fully typed in compliance with Pyright Strict, though some nuances remain between discord.py and wavelink. diff --git a/pyproject.toml b/pyproject.toml index 93c48007..3d6e3a1e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,7 @@ authors = [ ] dynamic = ["dependencies"] description = "A robust and powerful, fully asynchronous Lavalink wrapper built for discord.py in Python." -readme = "README.rst" +readme = "README.md" requires-python = ">=3.10" classifiers = [ "License :: OSI Approved :: MIT License", @@ -19,6 +19,7 @@ classifiers = [ "Operating System :: OS Independent", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Topic :: Internet", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules",