From 8be3d978be4036edc5039ce58f2ca4596b8cab4d Mon Sep 17 00:00:00 2001 From: Twentysix Date: Sun, 16 Apr 2017 02:15:38 +0200 Subject: [PATCH] New README --- README.md | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 27cec7a03..34849a6e7 100644 --- a/README.md +++ b/README.md @@ -5,36 +5,48 @@ #### *Music, admin, trivia, fun commands and much more!* [](https://www.patreon.com/Twentysix26) [](https://github.com/Rapptz/discord.py) [](https://discord.gg/red) [![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. -You can turn Red into a trivia bot, an admin bot, a music bot (...) or all of these together. +**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 is easy](https://twentysix26.github.io/Red-Docs/), 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 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!) +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, Hitbox, Beam) +* Slot machines * Custom commands * Imgur/gif search -* And much much more -# How to install this? +Additionally, other modules (cogs) can be easily found and added from our growing community of cog repositories. Including: +* Cleverbot integration (talk to Red and she talks back) +* Loggers +* Welcome messages setup +* Reminders +* Raffles +* Leveler (increase levels for server participation) +* DotA +* And much, much more! -The installation process is as straightforward as ever, all major platforms are supported: +Feel free to take a [peek](https://cogs.red/)! + +# Installation + +The installation process is straightforward; 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/) -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. +Read the [getting started](https://twentysix26.github.io/Red-Docs/red_getting_started/) guide to quickly learn how to use Red. -If you have any other questions, feel free to explore the [Wiki](https://twentysix26.github.io/Red-Docs/) for guidance. +If you have any other questions, feel free to explore the [Docs](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. +If [*after reading the guides*](https://twentysix26.github.io/Red-Docs/) you are still experiencing issues that are not listed on [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/red) for 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)! +Red is in continuous development, and it’s supported by an active community which produces new content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t [find](https://cogs.red/) what you’re looking for, we are open to suggestions! Stay tuned by [joining the official server](https://discord.gg/red)! # License