From 9d1b5c308458bc7d3c07dea86879ad6c849a30ec Mon Sep 17 00:00:00 2001
From: MSFTserver <sawyerlemmo@gmail.com>
Date: Sat, 23 Dec 2017 13:10:42 -0800
Subject: [PATCH] new readme for PR's and updates

added in spoiler as features is getting bulker
---
 README.md | 84 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 65 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 7621f95..f021838 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,85 @@
-# Bot for [LBRY's Discord](https://discord.gg/tgnNHf5)
+## Bot for [LBRY's Discord](https://discord.gg/tgnNHf5)
 
 (This README will be updated along with bot updates)
 
-## Features:
+<h3>
+<details><summary>Features:</summary>
 
-* Price bot displays price of lbc for currency given. Responds to `!price <cur>
-  <amount>`
-* Stats bot display current market stats of lbc. Responds to `!stats`
-* Hash bot displays current hashrate of network. Responds to `!hash`
+* Price bot displays price of lbc for currency given.
 
-  Also Includes `!hash power <MH/s>` to calculate given MH/s to LBC per hr, day,
-  week, month.
+  - *Responds to `!price <cur> <amount>`*
+
+* Stats bot displays current market stats of lbc.
+
+  - *Responds to `!stats`*
+
+* Hash bot displays current hashrate of lbc network. Also Includes to calculate given MH/s to LBC & fiat per hr, day, week, month.
+
+  - *Responds to `!hash`*
+
+  - *Responds to `!hash power <MH/s> <fiat>`*
+
+* AltStats bot displays current market stats of specfied currency
+
+  - *Responds to `!altstats <coin>`*
+
+* AltPrice bot displays current price for given coin and currency
+
+  - *Responds to `!altprice <coin> <currency> <amount>`*
 
 * Github Release Notes bot displays release notes for current lbry-app release.
 
-  Responds to `!releasenotes`
+  - *Responds to `!releasenotes`*
 
-  (moderator only) `!releasenotes post` to send to specified channel
+  - *(moderator only) `!releasenotes post` - send to release notes channel*
+
+* Purge Bot deletes X amount of messages.
+
+  - *(moderator only)  Responds to `!purge <X>`*
 
-* Purge Bot (moderator only) deletes X amount of messages. Responds to `!purge
-  <X>`
 * Speech bot displays top claim from provided image name(coming soon posting to
   speech).
 
-  Responds to `!speech <imagename>`
+  - *Responds to `!speech <imagename>`*
 
 * Welcome bot sends Direct Message when new users join,
 
-  (moderator only) Responds to `!welcome <@username>`
+  - *(moderator only) Responds to `!welcome <@username>`*
+
+* Timeout bot assigns members the timeout roll for X-minutes where they are restricted from talking
+
+  - *(moderator only) Responds to `!timeout <@username> <Mins>`*
+
+* Roll Setter bot allows users to assign themselves rolls
+
+  - *Responds to `!addrole <role>` - Adds to Role*
+
+  - *Responds to `!delrole <role>` - Deletes from Role*
+
+  - *Responds to `!roles` - List Available Roles*
+
+* LBRY URL Linker displays lbry:// urls as open.lbry.io links to make them clickable
+
+* LBRY claim bot displays recent publishes on the lbry protocol
+
+* IRC bot to connect an irc channel with discord
 
 * Spam Detection Bot to Prevent Discord Raids and Spammers
+
 * Dynamic plugin loading with permission support.
 
-## Requirements
+</details>
+</h3>
+
+____
+
+### Requirements
 
 * node > 8.0.0
 * npm > 0.12.x
 * yarn ( install with npm install -g yarn if not installed )
-
-## Installation
+____
+### Installation
 
 Create a bot and get the bot's API Token:
 https://discordapp.com/developers/applications/me
@@ -50,8 +91,8 @@ and run:
 yarn install
 node bot/bot.js
 ```
-
-## Development
+____
+### Development
 
 Be sure to run the command below before working on any code, this ensures
 prettier goes to work and keeps code to our standard.
@@ -59,3 +100,8 @@ prettier goes to work and keeps code to our standard.
 ```
 yarn install --production=false
 ```
+to run prettier before submitting your code simply run the following in the bots root directory.
+
+```
+yarn precommit
+```