[V3/Readme] Update V3 Readme (#1703)

* Update and rename README.rst to README.MD

* Update and rename README.MD to README.rst

Changed the file type back to rst from MD

* Update README.rst

Changed image size.

* Update README.rst

Changed the cogs.red link to point at issue 1398 until the portal displays V3 cogs.

* Update README.rst

Changed image host to imgur
This commit is contained in:
Redjumpman 2018-05-28 01:14:24 -04:00 committed by palmtree5
parent 757a3114dc
commit 6ae02d2d02

View File

@ -1,52 +1,112 @@
.. image:: https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop .. raw:: html
:target: http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop
:alt: Documentation Status
.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square <h1 align="center">
:target: http://makeapullrequest.com <br>
:alt: PRs Welcome <a href="https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop"><img src="https://imgur.com/pY1WUFX.png" alt="Red Discord Bot"></a>
<br>
Red Discord Bot
<br>
</h1>
.. image:: https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg .. raw:: html
:target: https://crowdin.com/project/red-discordbot
:alt: Crowdin
.. image:: https://img.shields.io/badge/Support-Red!-orange.svg <h4 align="center">Music, Moderation, Trivia, Stream Alerts and fully customizable.</h4>
:target: https://www.patreon.com/Red_Devs
:alt: Patreon
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg .. raw:: html
:target: https://github.com/ambv/black
:alt: Code style: black <p align="center">
<a href="https://discord.gg/red">
<img src="https://discordapp.com/api/guilds/133049272517001216/widget.png?style=shield">
</a>
<a href="https://www.patreon.com/Red_Devs">
<img src="https://img.shields.io/badge/Support-Red!-yellow.svg">
</a>
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/Made%20With-Python%203.6-blue.svg?style=for-the-badge">
</a>
<a href="https://crowdin.com/project/red-discordbot">
<img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg">
</a>
<a href="https://github.com/Rapptz/discord.py/tree/rewrite">
<img src="https://img.shields.io/badge/discord-py-blue.svg">
</a>
</p>
.. raw:: html
<p align="center">
<a href="#overview">Overview</a> •
<a href="#installation">Installation</a> •
<a href="http://red-discordbot.readthedocs.io/en/v3-develop/index.html">Documentation</a>
<a href="#plugins"></a> •
<a href="#join-the-community">Community</a> •
<a href="#license">License</a>
</p>
==========
Overview
==========
Red is a fully modular bot meaning all features and commands can be enabled/disabled to your liking, making it completely customizable.
This is also a *self-hosted bot* meaning you will need to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot, new best friend or all of these together!
`Installation <#installation>`_ is easy, and you do **NOT** need to know anything about coding! Aside from installation and updating, every part of the bot can be controlled from within Discord.
**The default set of modules includes and is not limited to:**
- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)
- Trivia (lists are included and can be easily added)
- Music features (YouTube, SoundCloud, local files, playlists, queues)
- Stream alerts (Twitch, Youtube, Mixer, Hitbox, Picarto)
- Slot machine
- Custom commands
- Imgur/gif search
******************** **Additionally, other plugins (cogs) can be easily found and added from our growing community of cog repositories.**
Red - Discord Bot v3
********************
**This is in beta and very much a work in progress. Regular use is not recommended. - Cleverbot integration (talk to Red and she talks back)
There will not be any effort made to prevent the breaking of current installations.** - Ban sync
- Welcome messages
- Casino
- Reaction roles
- Slow Mode
- Anilist
- And much, much more!
How to install Feel free to take a `peek <https://github.com/Cog-Creators/Red-DiscordBot/issues/1398>`_!
^^^^^^^^^^^^^^
Using python3 pip:: ==============
Installation
==============
pip install --process-dependency-links -U Red-DiscordBot **The following platforms are officially supported:**
redbot-setup
redbot <name>
To install requirements for voice:: - `Windows <https://red-discordbot.readthedocs.io/en/v3-develop/install_windows.html>`_
- `MacOS <https://red-discordbot.readthedocs.io/en/v3-develop/install_mac.html>`_
- `Ubuntu <https://red-discordbot.readthedocs.io/en/v3-develop/install_ubuntu.html>`_
- `Debian Stretch <https://red-discordbot.readthedocs.io/en/v3-develop/install_debian.html>`_
- `CentOS 7 <https://red-discordbot.readthedocs.io/en/v3-develop/install_centos.html>`_
- `Arch Linux <https://red-discordbot.readthedocs.io/en/v3-develop/install_arch.html>`_
- `Raspbian Stretch <https://red-discordbot.readthedocs.io/en/v3-develop/install_raspbian.html>`_
pip install --process-dependency-links -U Red-DiscordBot[voice] Already using **Red** V2? Take a look at the `Data Converter <https://red-discordbot.readthedocs.io/en/v3-develop/cog_dataconverter.html>`_ to import your data to V3.
To install all requirements for docs and tests:: If `after reading the guides <https://red-discordbot.readthedocs.io/en/v3-develop/>`_ you are still experiencing issues, feel free to join the `Official Server <https://discord.gg/red>`_ and ask in the **#support** channel for help.
pip install --process-dependency-links -U Red-DiscordBot[test,docs] =====================
Join the community!
=====================
For the latest git build, replace ``Red-DiscordBot`` in the above commands with **Red** is in continuous development, and its supported by an active community which produces new content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you cant `find <https://github.com/Cog-Creators/Red-DiscordBot/issues/1398>`_ what youre looking for, consult our `guide <https://red-discordbot.readthedocs.io/en/v3-develop/guide_cog_creation.html>`_ on building your own cogs!
``git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop``.
Contributing to Red Join us on our `Official Discord Server <https://discord.gg/red>`_!
^^^^^^^^^^^^^^^^^^^
See `CONTRIBUTING <.github/CONTRIBUTING.md>`_ for more information. =========
License
=========
Released under the `GNU GPL v3 <#License>`_.
Red is named after the main character of "Transistor", a videogame by `Super Giant Games <https://www.supergiantgames.com/games/transistor/>`_
Artwork created by `Sinlaire <https://sinlaire.deviantart.com/>`_ on Deviant Art for the Red Bot Project.