Better README.md (#568)

This commit is contained in:
orels 2017-01-09 20:05:03 +03:00 committed by Twentysix
parent 182e1d8614
commit e034615005

View File

@ -1,27 +1,43 @@
![intro](http://i.imgur.com/RgGlNpQ.jpg)
# Red - A fully customizable Discord bot
#### *Music, admin, trivia, fun commands and much more!*
[<img src="https://img.shields.io/badge/Support-me!-orange.svg">](https://www.patreon.com/Twentysix26) [<img src="https://img.shields.io/badge/discord-py-blue.svg">](https://github.com/Rapptz/discord.py) [<img src="https://discordapp.com/api/guilds/133049272517001216/widget.png?style=shield">](https://discord.gg/0k4npTwMvTpv9wrh) [![Build Status](https://travis-ci.org/Twentysix26/Red-DiscordBot.svg?branch=develop)](https://travis-ci.org/Twentysix26/Red-DiscordBot)
Red is a fully modular bot which comes with sets of features/commands that can be enabled/disabled to your liking, making it customizable exactly how you want.
> **Red** is a fully modular bot which comes with sets of features/commands that can be enabled/disabled to your liking, making it customizable exactly how you want.
You can turn Red into a trivia bot, an admin bot, a music bot (...) or all of these together.
The default set of modules includes and it's not limited to:
* moderation features (kick/ban/softban, filters, mod-log...)
* trivia (lists included and you can make new ones!)
* music features (playlists, youtube, soundcloud, queues...)
* stream alerts (twitch/hitbox)
* slot machines (yes, really!)
* custom commands
* imgur/gif search
* and much much more
* Moderation features (kick/ban/softban, filters, mod-log...)
* Trivia (lists included and you can make new ones!)
* Music features (playlists, youtube, soundcloud, queues...)
* Stream alerts (twitch/hitbox)
* Slot machines (yes, really!)
* Custom commands
* Imgur/gif search
* And much much more
Red is in continuous development, new features get added all the time and it's supported by an active community which produces even more content (plugins!). Stay tuned by [joining the official server](https://discord.gg/0k4npTwMvTpv9wrh)!
# How to install this?
### I don't know what you're waiting for, tell me how to install this already!
The installation process is as straightforward as ever, all major platforms are supported:
* [Windows](https://twentysix26.github.io/Red-Docs/red_install_windows/)
* [Linux](https://twentysix26.github.io/Red-Docs/red_install_linux/)
* [macOS](https://twentysix26.github.io/Red-Docs/red_install_mac/)
The installation process is as straightforward as ever: [[Wiki]](https://twentysix26.github.io/Red-Docs/).
Don't forget to read the [general tips](http://twentysix26.github.io/Red-Docs/red_general_tips/) for a better idea of how Red works.
Don't forget to read the [getting started](https://twentysix26.github.io/Red-Docs/red_getting_started/) guide to quickly learn about the main features of Red.
If [*after reading the guides*](https://twentysix26.github.io/Red-Docs/) you're still experiencing issues that are not listed in [this page](https://twentysix26.github.io/Red-Docs/red_guide_troubleshooting/), feel free to join the [official server](https://discord.gg/0k4npTwMvTpv9wrh) with your main account to get some help.
If you have any other questions, feel free to explore the [Wiki](https://twentysix26.github.io/Red-Docs/) for guidance.
If [*after reading the guides*](https://twentysix26.github.io/Red-Docs/) you're still experiencing issues that are not listed in [this page](https://twentysix26.github.io/Red-Docs/red_guide_troubleshooting/) or in the [FAQs](https://twentysix26.github.io/Red-Docs/red_faq/), feel free to join the [official server](https://discord.gg/0k4npTwMvTpv9wrh) with your main account to get some help.
Have fun!
# Join the community!
Red is in continuous development, new features get added all the time and it's supported by an active community that produces lots of content (plugins!) for everyone to enjoy. Stay tuned by [joining the official server](https://discord.gg/0k4npTwMvTpv9wrh)!
# License
Released under the [GNU GPL v3](LICENSE).
*Red is named after the main character of "Transistor", a videogame by [Supergiant Games](https://www.supergiantgames.com/games/transistor/)*