From cf4d2e23a28c940327cdbad32186230a00354678 Mon Sep 17 00:00:00 2001 From: Arthur Jovart Date: Sat, 28 Aug 2021 19:44:58 +0200 Subject: [PATCH] Update the README for the fork version. Also removes the japanese version. --- README.ja.rst | 113 -------------------------------------------------- README.rst | 51 ++++++++++++----------- 2 files changed, 27 insertions(+), 137 deletions(-) delete mode 100644 README.ja.rst diff --git a/README.ja.rst b/README.ja.rst deleted file mode 100644 index 11deab89..00000000 --- a/README.ja.rst +++ /dev/null @@ -1,113 +0,0 @@ -discord.py -========== - -.. image:: https://discord.com/api/guilds/336642139381301249/embed.png - :target: https://discord.gg/nXzj3dg - :alt: Discordサーバーの招待 -.. image:: https://img.shields.io/pypi/v/discord.py.svg - :target: https://pypi.python.org/pypi/discord.py - :alt: PyPIのバージョン情報 -.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg - :target: https://pypi.python.org/pypi/discord.py - :alt: PyPIのサポートしているPythonのバージョン - -discord.py は機能豊富かつモダンで使いやすい、非同期処理にも対応したDiscord用のAPIラッパーです。 - -主な特徴 -------------- - -- ``async`` と ``await`` を使ったモダンなPythonらしいAPI。 -- 適切なレート制限処理 -- メモリと速度の両方を最適化。 - -インストール -------------- - -**Python 3.8 以降のバージョンが必須です** - -完全な音声サポートなしでライブラリをインストールする場合は次のコマンドを実行してください: - -.. code:: sh - - # Linux/OS X - python3 -m pip install -U discord.py - - # Windows - py -3 -m pip install -U discord.py - -音声サポートが必要なら、次のコマンドを実行しましょう: - -.. code:: sh - - # Linux/OS X - python3 -m pip install -U discord.py[voice] - - # Windows - py -3 -m pip install -U discord.py[voice] - - -開発版をインストールしたいのならば、次の手順に従ってください: - -.. code:: sh - - $ git clone https://github.com/Rapptz/discord.py - $ cd discord.py - $ python3 -m pip install -U .[voice] - - -オプションパッケージ -~~~~~~~~~~~~~~~~~~~~~~ - -* PyNaCl (音声サポート用) - -Linuxで音声サポートを導入するには、前述のコマンドを実行する前にお気に入りのパッケージマネージャー(例えば ``apt`` や ``dnf`` など)を使って以下のパッケージをインストールする必要があります: - -* libffi-dev (システムによっては ``libffi-devel``) -* python-dev (例えばPython 3.6用の ``python3.6-dev``) - -簡単な例 --------------- - -.. code:: py - - import discord - - class MyClient(discord.Client): - async def on_ready(self): - print('Logged on as', self.user) - - async def on_message(self, message): - # don't respond to ourselves - if message.author == self.user: - return - - if message.content == 'ping': - await message.channel.send('pong') - - client = MyClient() - client.run('token') - -Botの例 -~~~~~~~~~~~~~ - -.. code:: py - - import discord - from discord.ext import commands - - bot = commands.Bot(command_prefix='>') - - @bot.command() - async def ping(ctx): - await ctx.send('pong') - - bot.run('token') - -examplesディレクトリに更に多くのサンプルがあります。 - -リンク ------- - -- `ドキュメント `_ -- `公式Discordサーバー `_ -- `Discord API `_ diff --git a/README.rst b/README.rst index a81adde7..b8fdf99a 100644 --- a/README.rst +++ b/README.rst @@ -1,22 +1,35 @@ discord.py ========== -.. image:: https://discord.com/api/guilds/336642139381301249/embed.png - :target: https://discord.gg/r3sSKJJ +.. image:: https://discord.com/api/guilds/514232441498763279/embed.png + :target: https://discord.gg/PYAfZzpsjG :alt: Discord server invite -.. image:: https://img.shields.io/pypi/v/discord.py.svg - :target: https://pypi.python.org/pypi/discord.py +.. image:: https://img.shields.io/pypi/v/enhanced-dpy.svg + :target: https://pypi.python.org/pypi/enhanced-dpy :alt: PyPI version info -.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg - :target: https://pypi.python.org/pypi/discord.py +.. image:: https://img.shields.io/pypi/pyversions/enhanced-dpy.svg + :target: https://pypi.python.org/pypi/enhanced-dpy :alt: PyPI supported Python versions -A modern, easy to use, feature-rich, and async ready API wrapper for Discord written in Python. +A modern, maintained, easy to use, feature-rich, and async ready API wrapper for Discord written in Python. -The Future of discord.py +The Future of enhanced-discord.py -------------------------- -Please read the `gist `_ for the future of this project. It's been a good one. +Enhanced discord.py is a fork of Rapptz's discord.py, that went unmaintained (`gist `_) + +It is currently maintained by (in alphabetical order) + +- Chillymosh#8175 +- Daggy#9889 +- dank Had0cK#6081 +- Dutchy#6127 +- Eyesofcreeper#0001 +- Gnome!#6669 +- IAmTomahawkx#1000 +- Jadon#2494 + +An overview of added features is available on the `custom features page `_. Key Features ------------- @@ -35,27 +48,17 @@ To install the library without full voice support, you can just run the followin .. code:: sh # Linux/macOS - python3 -m pip install -U discord.py + python3 -m pip install -U enhanced-dpy # Windows - py -3 -m pip install -U discord.py - -Otherwise to get voice support you should run the following command: - -.. code:: sh - - # Linux/macOS - python3 -m pip install -U "discord.py[voice]" - - # Windows - py -3 -m pip install -U discord.py[voice] + py -3 -m pip install -U enhanced-dpy To install the development version, do the following: .. code:: sh - $ git clone https://github.com/Rapptz/discord.py + $ git clone https://github.com/iDevision/enhanced-discord.py $ cd discord.py $ python3 -m pip install -U .[voice] @@ -113,6 +116,6 @@ You can find more examples in the examples directory. Links ------ -- `Documentation `_ -- `Official Discord Server `_ +- `Documentation `_ +- `Official Discord Server `_ - `Discord API `_ -- 2.47.2