From f8838b0af2efb35c7cb6c0e862048f2bce9d30bc Mon Sep 17 00:00:00 2001 From: Jeremy Zhang Date: Thu, 6 Apr 2017 03:50:55 +0000 Subject: [PATCH] Wrote README doc --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6db2d8e..7a8003a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ # Titan -Discord webpage embedded client +There was a time when Discord doesn't support embedding the chat on a webpage. But with Titan, you can! It is as simple as 1, 2, 3! +1. Invite the bot to your server (You must have "Manage Server" permissions) +2. Configure the embed to your liking (toggling guest users, etc) +3. Copy the iframe code and paste the line in your webpage! -## Required PIP Packages -- flask -- flask-sqlalchemy -- cachetools -- Flask-Cache -- flask_limiter -- requests_oauthlib -- mysql-python \ No newline at end of file +# Features +- Guest users (a quick way to invite users who do not have a Discord account) +- Moderation Features (Kick & ban users by IP addresses, toggling guest users) +- Discord OAuth support. (Allows those who have a discord account to access the embed) +- Responsive material design! (Thanks materializecss!!) +- All features are done via REST apis (respects discord's rate limiting). Although do not provide consistant connection to Discord, they are easier to maintain and does not often "disconnects" from Discord servers. + +# Installation +Would you like to run your own copy of Titan Embeds? +1. Clone the repo +2. Install the pip requirements `pip install -r requirements.txt` +3. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards +4. Run the development web via `python run.py` -- Though we suggest to use a better server software (look into gunicorn, nginx, etc) + + +## Join us! +Come and talk with us at our very own [discord server](https://discord.gg/z4pdtuV)! We offer support too! \ No newline at end of file