Skip to content

Commit b01b7b8

Browse files
authored
Added a few informations
1 parent 2945eec commit b01b7b8

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.rst

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Welcome to discord.py-message-components' documentation!
1+
🇺🇦 Welcome to discord.py-message-components'! 🇺🇦
22
=========================================================
33

44
.. figure:: https://cdn.discordapp.com/attachments/852872100073963532/854711446767796286/discord.py-message-components.png
55
:name: discord.py-message-components
66
:align: center
77
:alt: Name of the Project (discord.py-message-components)
8-
8+
99
..
1010
.. image:: https://discord.com/api/guilds/852871920411475968/embed.png
1111
:target: https://discord.gg/sb69muSqsg
@@ -27,7 +27,14 @@ Welcome to discord.py-message-components' documentation!
2727
:target: https://discordpy-message-components.readthedocs.io/en/latest/
2828
:alt: Documentation Status
2929

30-
The Original `discord.py <https://pypi.org/project/discord.py/1.7.3>`_ Library made by `Rapptz <https://github.com/Rapptz>`_ with implementation of the `Discord-Message-Components <https://discord.com/developers/docs/interactions/message-components>`_ by `mccoderpy <https://github.com/mccoderpy/>`_
30+
A "fork" of `discord.py <https://pypi.org/project/discord.py/1.7.3>`_ library made by `Rapptz <https://github.com/Rapptz>`_ with implemation of the `Discord-Message-Components <https://discord.com/developers/docs/interactions/message-components>`_ by `mccoderpy <https://github.com/mccoderpy/>`_
31+
32+
**NOTE:**
33+
This library will be further developed independently of discord.py.
34+
New features are also implemented. It's not an extension!
35+
The name only comes from the fact that the original purpose of the library was to add support for message components and we haven't found a better one yet.
36+
37+
**❗Also important to know❗:** `Why is this library so inactive at the moment? <https://github.com/mccoderpy/discord.py-message-components/discussions/17#>`_
3138

3239
.. figure:: https://github.com/mccoderpy/discord.py-message-components/raw/main/images/rtd-logo-wordmark-light.png
3340
:name: discord.py-message-components documentation
@@ -41,14 +48,14 @@ Welcome to discord.py-message-components' documentation!
4148
You need help? Or have ideas/feedback?
4249
______________________________________
4350

44-
Open a Issue/Pull request on `GitHub <https://github.com/mccoderpy/discord.py-message-components/pulls>`_, join the `support-Server <https://discord.gg/sb69muSqsg>`_ or send me a direct-message on `Discord <https://discord.com/channels/@me>`_: ``mccuber04#2960``
51+
Open a Issue/Pull request on `GitHub <https://github.com/mccoderpy/discord.py-message-components/pulls>`_, join the `support-server <https://discord.gg/sb69muSqsg>`_ or send me a direct-message on `Discord <https://discord.com/channels/@me>`_: ``mccuber04#2960``
4552

4653
Installing
4754
__________
4855

4956
**Python 3.5.3 or higher is required**
5057

51-
This Library overwrite the original discord.py Library so to be sure all will work fine
58+
This library overwrite the original discord.py library (or any other that would be imported using `import discord`) so to be sure all will work fine
5259
first uninstall the original `discord.py <https://pypi.org/project/discord.py/1.7.3>`_ Library if it is installed:
5360

5461
.. code:: sh
@@ -59,7 +66,7 @@ first uninstall the original `discord.py <https://pypi.org/project/discord.py/1.
5966
# Windows
6067
py -3 -m pip uninstall discord.py
6168
62-
Then install `this Library <https://pypi.org/project/discord.py-message-components>`_ using:
69+
Then install `this library <https://pypi.org/project/discord.py-message-components>`_ using:
6370

6471
.. code:: sh
6572
@@ -69,6 +76,18 @@ Then install `this Library <https://pypi.org/project/discord.py-message-componen
6976
# Windows
7077
py -3 -m pip install -U discord.py-message-components
7178
79+
‼️To install it from the `developer-branch <https://github.com/mccoderpy/discord.py-message-components/tree/developer>`_ of this library which is the **most up to date** and has **fewer bugs** use:
80+
81+
.. code:: sh
82+
83+
# Linux/macOS
84+
python3 -m pip install -U git+https://github.com/mccoderpy/discord.py-message-components.git@developer
85+
86+
# Windows
87+
py -m pip install -U git+https://github.com/mccoderpy/discord.py-message-components.git@developer 
88+
89+
Of curse you nead to have git installed on your device. If you need help with this take a look `here <https://github.com/git-guides/install-git>`_
90+
7291
Examples
7392
--------
7493

0 commit comments

Comments
 (0)