diff --git a/docs/commands.md b/docs/commands.md index cc7ca0e..90c3c90 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,9 +1,35 @@ -- stock :bank: -- cryptocurrency :material-currency-btc: -- otc :dollar: -- bot :robot: +# Key -# /donate :robot: +Symbols are used in headings to denote what platforms and symbol types a command supports. + +- Telegram Only :fontawesome-brands-telegram-plane: +- Discord Only :fontawesome-brands-discord: +- Bot Commands :robot: +- Cryptocurrency Support :material-currency-btc: +- Stock Market Support :bank: +- OTC Support :dollar: + +# Symbol Detection :material-currency-btc: :bank: :dollar: + +The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell. + +
+
+
+ I wonder how $tsla is affecting the price of $$btc +
+
+ The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68% +
+
+ The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today +
+
+
+ +# `/donate [Amount in USD]` :fontawesome-brands-telegram-plane: + +The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](#donate) page for more information.
@@ -17,7 +43,9 @@
-# /status :robot: +# `/status` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord: + +This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](#contact)
@@ -38,7 +66,9 @@ Bot Status:
-# /dividend :bank: +# `/dividend [symbol]` :bank: + +This command gives the rate and date of the dividend for a stock symbol.
@@ -47,7 +77,7 @@ Bot Status:
The next dividend for $PSEC: Prospect Capital Corp is on Thursday, August 4 which is in 44 days. The dividend is for $0.06 per share. - +

The dividend was declared on Monday, May 1 and the ex-dividend date is Tuesday, July 2
@@ -55,35 +85,47 @@ The dividend was declared on Monday, May 1 and the ex-dividend date is Tuesday,
-# /intra :bank: :material-currency-btc: +# `/intra [symbol]` :bank: :material-currency-btc: + +This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
- /intra + /intra $astr
- The current stock price of Tesla Inc is $664.315, the stock is - currently down -0.99% + Tesla Motors Chart +

Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59

+

The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%

+
+
-# /chart :bank: :material-currency-btc: +# `/chart [symbol]` :bank: :material-currency-btc: + +This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
- /chart + /intra $astr
- The current stock price of Tesla Inc is $664.315, the stock is - currently down -0.99% + Tesla Motors Chart +

1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021

+

The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today

+
+
-# /news :bank: +# `/news [symbol]` :bank: + +Gets the most recent, non paywalled, english news for a stock.
@@ -101,7 +143,9 @@ Tesmanian: Brandenburg Minister Supports Bureaucratic Reform & Hopes Tesla Giga
-# /info :bank: :material-currency-btc: +# /info :fontawesome-brands-telegram-plane: :fontawesome-brands-discord: :bank: :material-currency-btc: + +Gets a description of a company. Aimed to inform you on what a ticker is if you have no prior knowledge of it.
@@ -114,7 +158,9 @@ Virgin Galactic Holdings, Inc. is a vertically integrated aerospace and space tr
-# /stat +# `/stat [symbol]` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord: + +Gets key market data of the symbol passed in.
@@ -131,10 +177,24 @@ Cardano Statistics: Community: 12.066 Public Interest: 0.285 +
+ /stat $$ada +
+ 
+Company Name: Prospect Capital Corp
+Market Cap: $3,280,433,315
+52 Week (high-low): 9.19 - 4.21
+Number of Employees: 0
+Next Earnings Date: 2021-08-26
+Price to Earnings: 0.000
+Beta: 0.404
+
-# /trending +# `/trending` :fontawesome-brands-telegram-plane: + +Gets the latest trending stocks and their change in price
@@ -173,7 +233,9 @@ $$MLN: Enzyme, 32.85%
-# /help +# /help :robot: + +Just a simple command to get help in app. Returns a more summarized version of this page.
@@ -187,14 +249,10 @@ $$MLN: Enzyme, 32.85%
-# Inline Features +# Inline Features :fontawesome-brands-telegram-plane: :material-currency-btc: :bank: :dollar: You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock symbols and return the price of the ticker. Then once you select the ticker want the bot will send a message as you in that chat with the latest stock price. The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a `$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors. - -Market data is provided by [IEX Cloud](https://iexcloud.io) - - If you believe the bot is not behaving properly run `/status`. diff --git a/docs/img/TgChartChat.jpg b/docs/img/TgChartChat.jpg new file mode 100644 index 0000000..2cfdb35 Binary files /dev/null and b/docs/img/TgChartChat.jpg differ diff --git a/docs/img/TgIntraChat.jpg b/docs/img/TgIntraChat.jpg new file mode 100644 index 0000000..11e06ea Binary files /dev/null and b/docs/img/TgIntraChat.jpg differ diff --git a/docs/stylesheets/phone.css b/docs/stylesheets/phone.css index f08324c..0bb40a9 100644 --- a/docs/stylesheets/phone.css +++ b/docs/stylesheets/phone.css @@ -11,6 +11,7 @@ overflow-x: hidden; position: relative; border-radius: 10px; + margin: 50px; } .messages-wrapper { position: relative;