formatting and docs on new commands

README.md

@@ -1,3 +1,4 @@
+<div align="center">
 <p align="center">
   <a href="" rel="noopener">
  <img width=200px height=200px src="https://assets.gitlab-static.net/uploads/-/system/project/avatar/10273693/logo.jpg" alt="Simple Discord Stock Bot"></a>
@@ -5,11 +6,11 @@
 
 <h3 align="center">Simple Discord Stock Bot</h3>
 
-<div align="center">
+<a href="https://www.buymeacoffee.com/Anson" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Beer" style="height: 51px !important;width: 217px !important;" ></a>
 
-  [![Status](https://img.shields.io/badge/status-active-success.svg)]()
+[![Status](https://img.shields.io/badge/status-active-success.svg)]()
-  [![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/)
+[![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)]()
-  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 
 </div>
 
@@ -20,17 +21,19 @@
 </p>
 
 ## 📝 Table of Contents
-+ [About](#about)
+
-+ [How it works](#working)
+- [About](#about)
-+ [Usage](#usage)
+- [How it works](#working)
-+ [Getting Started](#getting_started)
+- [Usage](#usage)
-+ [Deploying your own bot](#deployment)
+- [Getting Started](#getting_started)
-+ [Built Using](#built_using)
+- [Deploying your own bot](#deployment)
-+ [Contributing](../CONTRIBUTING.md)
+- [Built Using](#built_using)
-+ [author](#author)
+- [Contributing](../CONTRIBUTING.md)
-+ [Acknowledgments](#acknowledgement)
+- [author](#author)
+- [Acknowledgments](#acknowledgement)
 
 ## 🧐 About <a name = "about"></a>
+
 This bot aims to be as simple as possible while providing all the information you need on the stock market. The motivation of this bot is to provide similar stock market functionality that the Google Assistant provided in [Google Allo](https://gcemetery.co/google-allo/) before the project was sunset.
 
 ## 💭 How it works <a name = "working"></a>
@@ -42,56 +45,72 @@ This bot works by using the [IEX API 2.0](https://iexcloud.io/docs/api/). Using
 ### Basic Usage
 
 The simplest way to use the bot is just by sending a message either as a direct message or in a group chat with the bot active. The bot will search every message for text with a dollar sign followed by a stock symbol, and it will return the full name of the company and the current trading price.
+
 ```
 $tsla
 ```
+
 The symbols can be anywhere in the message, and you can post as many as you like so commands such as:
+
 ```
 I wonder if $aapl is down as much as $msft is today.
 ```
+
 would return the stock price of both Apple and Microsoft like so:
+
 ```
 The current stock price of Microsoft Corp. is $131.4, the stock is currently up 2.8%
 
 The current stock price of Apple, Inc. is $190.15, the stock is currently up 2.66%
 ```
 
-### /dividend
+### /search `query`
+
+This command takes any query and searches all tickers and company names that the bot supports and returns matches. The bot uses IEX Cloud so market information is limited to what they support, which is still about ~15,000 tickers so anything in a United States exchange should have support.
+
+### /dividend \$ticker
 
 To get information about the dividend of a stock type `/dividend` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
+
 ```
 /dividend $psec
 ```
+
 Would return information about Prospect Capitals dividend:
+
 ```
-Prospect Capital Corp. Declares June 2019 Dividend of $0.06 Per Share 
+Prospect Capital Corp. Declares June 2019 Dividend of $0.06 Per Share
 The dividend is in: 38 Days 3 Hours 53 Minutes 22 Seconds.
 ```
 
 💡 you can also call the dividend command using /div
 
-### /news
+### /news \$ticker
 
 To get the latest news about a stock symbol use `/news` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
+
 ```
 /news $psec
 ```
+
 Would return news for Prospect Capital:
 
 News for PSEC:
 
-  [Yield-Starved Investors Still Accumulating BDCs Paying More Than 10% Annually](https://cloud.iexapis.com/v1/news/article/d994b8b5-9fbf-4ceb-afbe-e6defcfc6352)
+[Yield-Starved Investors Still Accumulating BDCs Paying More Than 10% Annually](https://cloud.iexapis.com/v1/news/article/d994b8b5-9fbf-4ceb-afbe-e6defcfc6352)
 
-  [Assessing Main Street Capital's Results For Q1 2019 (Includes Updated Price Target And Investment Ratings Analysis)](https://cloud.iexapis.com/v1/news/article/e60899bc-5230-4388-a609-fc2b8736a7d4)
+[Assessing Main Street Capital's Results For Q1 2019 (Includes Updated Price Target And Investment Ratings Analysis)](https://cloud.iexapis.com/v1/news/article/e60899bc-5230-4388-a609-fc2b8736a7d4)
 
-  [Fully Assessing Prospect Capital's Fiscal Q3 2019 (Includes Current Recommendation And Price Target)](https://cloud.iexapis.com/v1/news/article/08881160-72c5-4f5d-885b-1751187d24eb)
+[Fully Assessing Prospect Capital's Fiscal Q3 2019 (Includes Current Recommendation And Price Target)](https://cloud.iexapis.com/v1/news/article/08881160-72c5-4f5d-885b-1751187d24eb)
 
-### /info
+### /info \$ticker
 
 To get information about a stock type `/info` followed by any text that has symbols with a dollar sign in front of them. So, the following command:
+
 ```
 /info $psec
 ```
+
 Would return information about Prospect Capitals:
 
 Company Name: [Prospect Capital Corp.](http://www.prospectstreet.com/)  
@@ -102,7 +121,7 @@ Description: Prospect Capital Corp. is a business development company, which eng
 
 ## 🏁 Getting Started <a name = "getting_started"></a>
 
-You can either choose to use the hosted version of the bot by [clicking here](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) or you can host your own bot with the instructions below. 
+You can either choose to use the hosted version of the bot by [clicking here](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) or you can host your own bot with the instructions below.
 
 ### Self Hosted Bot
 
@@ -118,7 +137,7 @@ Finally, you will need and IEX Cloud API key. They offer a free tier that should
 
 ### Installing
 
-Once Docker is installed and you have your API keys for Discord and IEX Cloud getting the bot running on any platform is extremely easy. 
+Once Docker is installed and you have your API keys for Discord and IEX Cloud getting the bot running on any platform is extremely easy.
 
 Download or clone the repository to your machine and open a terminal in the project and build the Docker container.
 
@@ -135,19 +154,23 @@ docker run --detach \
       simple-discord-bot
 ```
 
-Your bot should be running! If you are new to Docker, I would recommend checking out its documentation for full control over your bot. 
+Your bot should be running! If you are new to Docker, I would recommend checking out its documentation for full control over your bot.
 
 ## 🚀 Deploying your own bot <a name = "deployment"></a>
+
 I recommend Digital Ocean for small projects like this because it is straightforward to use and affordable. [Sign up with my referral code, and we both get some free hosting.](https://m.do.co/c/6b5df7ef55b6)
 
 ## ⛏️ Built Using <a name = "built_using"></a>
-+ [discord.py](https://github.com/Rapptz/discord.py) - Python Discord API Wrapper
+
-+ [Digital Ocean](https://www.digitalocean.com/) - IaaS hosting platform
+- [discord.py](https://github.com/Rapptz/discord.py) - Python Discord API Wrapper
+- [Digital Ocean](https://www.digitalocean.com/) - IaaS hosting platform
 
 ## ✍️ author <a name = "author"></a>
-+ [Anson Biggs](https://blog.ansonbiggs.com/author/anson/) - The one and only
+
+- [Anson Biggs](https://blog.ansonbiggs.com/author/anson/) - The one and only
 
 ## 🎉 Acknowledgements <a name = "acknowledgement"></a>
-+ Discord for having a great bot API
+
-+ IEX Cloud for offering a free tier
+- Discord for having a great bot API
-+ Viewers like you ♥
+- IEX Cloud for offering a free tier
+- Viewers like you ♥