Update readme installation instructions and add browserstack

README.md

@@ -6,19 +6,22 @@ There was a time when Discord doesn't support embedding the chat on a webpage. B
 2. Configure the embed to your liking (toggling guest users, etc)
 3. Copy the iframe code and paste the line in your webpage!
 
-# Features
+## 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!!)
 
-# Installation
+## Installation
 Would you like to run your own copy of Titan Embeds? There are two parts that integrate nicely together. The webapp (website) handles the frontend and communication with the database to retrieve server messages, etc. The discordbot (bot) handles the communcation
-between Discord's websockets and pushing out the data to the database for the webapp. Check out the respective folder for their installation instructions.
+between Discord's websockets and pushing out the data to the database for the webapp. Check out the respective folder for their installation instructions. Titan is written in Python and requires **Python 3.5.5** at minimum to run.
+
+Once you cloned the project, install the Python depends with `pip install -r requirements.txt`. Ensure that you are utilizing Python 3.5's pip.
 
 If you happen to have a copy of Ubuntu on your server, you may head onto our [Ansible Playbooks](https://github.com/TitanEmbeds/ansible-playbooks) repository and perform a **near-to-automatic** installation of TitanEmbeds.
 
-# Database installation
+## Storage installation
+### Database
 To set up the database for it to work with the webapp and the discordbot, one must use **alembic** to *migrate* their databases to the current database state. To do so, please follow these instructions.
 **PostgreSQL supports proper indexing and suitable for Titan needs. For this reason, Titan only supports using a PostgreSQL database.**
 1. Install alembic with **Python 3.5's pip** `pip install alembic`
@@ -27,6 +30,8 @@ To set up the database for it to work with the webapp and the discordbot, one mu
 4. In your terminal, run `alembic upgrade head` to upgrade your database tables to the current version on git. As long as there are only *INFO* messages and no errors, you should be fine.
 5. Check your database tables to see if they are created. If so, you have finished migrating your database! **Remember to run *Step 4* every now and then just in case if there are database updates.** (Presumably on every `git pull`).
 
+### Redis
+Titan also requires a Redis instance in order to function. There is no specific prerequisites before utilizing Titan with redis. Follow the official Redis [installation instructions](https://redis.io/topics/quickstart) to install and start redis.
 
 ## Join us!
 Come and talk with us at our very own [Discord server](https://discord.gg/z4pdtuV)! We offer support too!
@@ -37,4 +42,8 @@ Visit us over at our [CrowdIn project](http://translate.titanembeds.com/) and te
 ## Disclaimer
 This project is never to be used as a replacement for Discord app. It is used in conjunction for a quick and dirty Discord embed for websites. Some uses are via shoutboxes, etc.
 
-[![alt text](https://discordbots.org/api/widget/299403260031139840.png "Upvote us on DiscordBots.org!")](https://discordbots.org/bot/299403260031139840)
+## Badges
+### Upvote us on DiscordBots.org
+[![DiscordBots.org](https://discordbots.org/api/widget/299403260031139840.png "Upvote us on DiscordBots.org!")](https://discordbots.org/bot/299403260031139840)
+### We proudly test our embeds to ensure a cross browser compatibility
+[![BrowserStack](https://i.imgur.com/nlMHPwl.png)](https://www.browserstack.com/)

discordbot/README.md

@@ -3,7 +3,6 @@ The DiscordBot portion handles the communcation with Discord's websockets to pro
 It also includes misc. features to moderate guest users, etc. right in your discord server!
 
 # Installation
-1. Clone the repo (make sure you have **Python 3.5** installed on your system. This discordbot portion depends on that specifc Python version)
+1. Clone the repo (make sure you have **Python 3.5** (or above) installed on your system.)
-2. Install the pip requirements `pip install -r requirements.txt`
+2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
-3. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
+3. Start the bot using `python run.py`
-4. Start the bot using `python run.py`

webapp/README.md

@@ -2,7 +2,6 @@
 The webapp portion handles the frontend (it's what the users see). The webapp highly depends on the discordbot to push websockets data to the database.
 
 # Installation
-1. Clone the repo (make sure you have **Python 3.5** installed on your system. This webapp portion depends on that specific python version)
+1. Clone the repo (make sure you have **Python 3.5.5** (or above) installed on your system.)
-2. Install the pip requirements `pip install -r requirements.txt`
+2. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
-3. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
+3. Run the development web via `python run.py` -- Though we suggest to use a better server software (look into gunicorn, nginx, uwsgi, etc)
-4. Run the development web via `python run.py` -- Though we suggest to use a better server software (look into gunicorn, nginx, uwsgi, etc)