diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 0000000..cc7ca0e --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,200 @@ +- stock :bank: +- cryptocurrency :material-currency-btc: +- otc :dollar: +- bot :robot: + +# /donate :robot: + +
+
+
+ /donate +
+
+ The current stock price of Tesla Inc is $664.315, the stock is + currently down -0.99% +
+
+
+ +# /status :robot: + +
+
+
+ /status +
+
+Bot Status: + It took 0.783369 seconds for the bot to get your message. + + Stock Market Data: + IEX Cloud is currently not reporting any issues with its API. + + Cryptocurrency Data: + CoinGecko API responded that it was OK in 0.160962 Seconds. +
+
+ +
+ +# /dividend :bank: + +
+
+
+ /dividend $psec +
+
+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 + +
+
+ +
+ +# /intra :bank: :material-currency-btc: + +
+
+
+ /intra +
+
+ The current stock price of Tesla Inc is $664.315, the stock is + currently down -0.99% +
+
+
+ +# /chart :bank: :material-currency-btc: + +
+
+
+ /chart +
+
+ The current stock price of Tesla Inc is $664.315, the stock is + currently down -0.99% +
+
+
+ +# /news :bank: + +
+
+
+ /news +
+
+News for TSLA:
+Top Tech News: Elon Musk admits self-driving is harder than he thought as Tesla owners troll him over missed deadlines
+Bitcoin Ethereum News: DOGE Price Analysis $0.231 | Cryptopolitan
+Tesla North: Bugatti to Merge with EV Hypercar Startup Rimac
+Tesla North: China-Made Tesla Model 3 Battery Drain Test After 14 Days of Sleep
+Tesmanian: Brandenburg Minister Supports Bureaucratic Reform & Hopes Tesla Giga Berlin Production Starts this Year
+        
+
+
+ +# /info :bank: :material-currency-btc: + +
+
+
+ /info $spce +
+
+Virgin Galactic Holdings, Inc. is a vertically integrated aerospace and space travel company, pioneering human spaceflight for private individuals and researchers, as well as a manufacturer of advanced air and space vehicles. It is developing a spaceflight system designed to offer customers a unique and transformative experience. +
+
+
+ +# /stat + +
+
+
+ /stat $$ada +
+
+Cardano Statistics:
+    Market Cap: $0.0
+    Market Cap Ranking: None
+    CoinGecko Scores:
+        Overall: 8.928
+        Development: 0.0
+        Community: 12.066
+        Public Interest: 0.285
+        
+
+
+ +# /trending + +
+
+
+ /trending +
+
+Trending Stocks: +``` +$SPCE: Virgin Galactic Holdings Inc - Class A, 0.04% +$MRIN: Marin Software Inc, 0.35% +$AMC: AMC Entertainment Holdings Inc - Class A, -0.04% +$ITRM: Iterum Therapeutics Plc, -0.38% +$AAPL: Apple Inc, 0.02% +$WISH: ContextLogic Inc - Class A, -0.05% +$AHT: Ashford Hospitality Trust Inc, -0.08% +$AMD: Advanced Micro Devices Inc., 0.01% +$CTXR: Citius Pharmaceuticals Inc, -0.17% +$F: Ford Motor Co., 0.00% +``` + +Trending Crypto: + +``` +$$BOND: BarnBridge, -5.29% +$$SHIB: Shiba Inu, -3.76% +$$SNX: Synthetix Network Token, 21.45% +$$COMP: Compound, 11.95% +$$MATIC: Polygon, -4.11% +$$AXS: Axie Infinity, -9.02% +$$MLN: Enzyme, 32.85% +``` + +
+
+ +
+ +# /help + +
+
+
+ /help +
+
+ The current stock price of Tesla Inc is $664.315, the stock is + currently down -0.99% +
+
+
+ +# Inline Features + +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/contact.md b/docs/contact.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/host.md b/docs/host.md new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/host.md @@ -0,0 +1 @@ + diff --git a/docs/img/telegramBotTickerReply.png b/docs/img/telegramBotTickerReply.png deleted file mode 100644 index c134684..0000000 Binary files a/docs/img/telegramBotTickerReply.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index 7e6b98c..a71c1c4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,5 @@ # Simple Stock Bots -Buy me a beerBuy me a beer - [![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot) [![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://tldrlegal.com/license/mit-license#summary) @@ -19,29 +17,23 @@ The bots can either be added to a server or can be direct messaged for the exact - [Telegram](https://t.me/SimpleStockBot) - [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) -Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](#source-code) +Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](#host) ## Usage The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds. -### Automatic +- `/donate [amount in USD]` to donate. đŸŽ—ī¸ +- `/dividend $[symbol]` Dividend information for the symbol. 📅 +- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈 +- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊 +- `/news $[symbol]` News about the symbol. 📰 +- `/info $[symbol]` General information about the symbol. â„šī¸ +- `/stat $[symbol]` Key statistics about the symbol. đŸ”ĸ +- `/trending` Trending Stocks and Cryptos. đŸ’Ŧ +- `/help` Get some help using the bot. 🆘 -Anytime the Bot is in your chat it will search all chats for `$` followed by a ticker. For example `$tsla` will return the following message for Tesla Motors: - -``` -The current stock price of Tesla Inc. is $321.35, the stock is currently up 2.7% -``` - -This works no matter where the ticker is in the message and you can have as many tickers as you want in the same message. For example: - -``` -I wonder how $aapl, $nflx, and $sono are performing today. -``` - -Will return: - -![Conversation With Simple Telegram Bot](img\telegramBotTickerReply.png) +Please see [Commands](#commands) for detailed usage. ### Universal Commands diff --git a/docs/stylesheets/phone.css b/docs/stylesheets/phone.css new file mode 100644 index 0000000..f08324c --- /dev/null +++ b/docs/stylesheets/phone.css @@ -0,0 +1,39 @@ +/* https://codepen.io/RG/pen/bdfDI */ +.phone { + background: none repeat scroll 0 0 #fff; + /*border-left: 1px solid #ccc; + border-right: 1px solid #ccc;*/ + color: #ffffff; + font-family: sans-serif; + line-height: 20px; + width: 80%; + margin: 0 auto; + overflow-x: hidden; + position: relative; + border-radius: 10px; +} +.messages-wrapper { + position: relative; +} +.message { + margin: 10px; + padding: 15px 20px; + position: relative; + overflow-x: auto; +} +.message.to { + border-radius: 20px 0px 20px 20px; + background-color: #2095fe; + color: #fff; + margin-left: 20%; +} +.message.from { + border-radius: 20px 20px 20px 0px; + background-color: #e5e4e9; + color: #363636; + margin-right: 20%; +} +.message.to + .message.to, +.message.from + .message.from { + margin-top: -7px; +} diff --git a/docs/telegram.md b/docs/telegram.md deleted file mode 100644 index c2ef359..0000000 --- a/docs/telegram.md +++ /dev/null @@ -1,24 +0,0 @@ -Keep up with the latest news for the bot in itsTelegram Channel: [https://t.me/simplestockbotnews](https://t.me/simplestockbotnews) - -## Commands - -- `/donate [amount in USD]` to donate. đŸŽ—ī¸ -- `/dividend $[symbol]` will return dividend information for the symbol. 📅 -- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈 -- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊 -- `/news $[symbol]` News about the symbol. 📰 -- `/info $[symbol]` General information about the symbol. â„šī¸ -- `/stat $[symbol]` Key statistics about the symbol. đŸ”ĸ -- `/help` Get some help using the bot. 🆘 - -## Inline Features - -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/mkdocs.yml b/mkdocs.yml index 80ee756..8574bb1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,20 +1,20 @@ -site_name: Simple Stock Bot +site_name: Simple Stock Bot Docs site_url: https://docs.simplestockbot.com edit_uri: /simple-stock-bots/site/tree/master/docs nav: - Home: index.md - - Telegram Commands: telegram.md + - Commands: commands.md + - Hosting: host.md - Donate: donate.md - - Contact (Email): mailto:anson@ansonbiggs.com + - Contact: contact.md - LICENSE: LICENSE.md - -theme: + +theme: name: "material" features: - navigation.tabs icon: - logo: - material/robot-love + logo: material/robot-love palette: - media: "(prefers-color-scheme: light)" scheme: default @@ -31,12 +31,18 @@ repo_url: https://gitlab.com/simple-stock-bots repo_name: Simple Stock Bots site_description: Simple Discord and Telegram chat bots for Stock Market Data. site_author: Anson Biggs -copyright: Anson Biggs 2018
All market data is provided by IEX Cloud +copyright: Anson Biggs 2018
Available Under an MIT LICENSE
All market data is provided by IEX Cloud + +extra_css: + - stylesheets/phone.css markdown_extensions: - admonition - toc: permalink: true + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg plugins: - search