diff --git a/docs/about.md b/docs/about.md deleted file mode 100644 index 38011a4..0000000 --- a/docs/about.md +++ /dev/null @@ -1 +0,0 @@ -# Under Construction 🚧 \ No newline at end of file diff --git a/docs/commands.md b/docs/commands.md deleted file mode 100644 index a44c651..0000000 --- a/docs/commands.md +++ /dev/null @@ -1,38 +0,0 @@ -# Telegram Bot Commands - -Buy me a beerBuy me a beer - -## Getting a Stock Quote - -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) - -## Commands - -- [`/help`](#/help) - Create a new project. -- [`/news`](#/news) - Start the live-reloading docs server. - -### /help - -This command just displays a short description of what the bot does and a link to this page. - -### /news - -This command is intelligent enough to get any tickers in the ticker format: `$amzn`, and can handle as many tickers as you would like to enter. For example saying `/news $tsla $aapl` would reply two different messages one for each ticker with a few news articles provided by the [IEX API](https://iexcloud.io/s/62c8503e). - -_The bots need more commands, feel free to [open an issue](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/issues) with suggestions._ - -[All market data is provided by IEX Cloud](https://iexcloud.io) diff --git a/docs/donate.md b/docs/donate.md new file mode 100644 index 0000000..8f4ad3d --- /dev/null +++ b/docs/donate.md @@ -0,0 +1,14 @@ +Simple Stock Bot is run entirely on donations. +All donations go directly towards paying for servers, and market data is provided by +[IEX Cloud](https://iexcloud.io/). + +The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson,which) accepts Paypal or Credit card. + +Alternatively, you can donate on Telegram with the `/donate` command. + +You can also support the bot indirectly by using the following referal links: + +- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) +- [IEX Cloud](https://iexcloud.io/s/62c8503e) + +If you have any questions get in touch: [anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/) diff --git a/docs/index.md b/docs/index.md index 9abe660..7e6b98c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,16 +19,12 @@ 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. +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) ## 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. -Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson) - -Full documentation can be found [here.](https://simple-stock-bots.gitlab.io/site/telegram/) - ### Automatic 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: @@ -54,15 +50,15 @@ Will return: - /info `$[symbol]` will return general information about the symbol. - /search `query` Takes a search string, whether a company name or ticker and returns a list of companies that are supported by the bot. -### Telegram Inline Messaging +### Telegram 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. +For the full list of Telgram bot features see [Telegram Commands](./telegram) --- -## Support the Project / Me +## Support the Project -If you appreciate these bots please consider donating or contributing in another way so that they can remain free, and so that I can continue to post free things on the world wide web. +If you appreciate these bots please consider [donating](./donate) or contributing in another way so that they can remain free, and so that I can continue to post free things on the world wide web. ### Ways to help: @@ -93,5 +89,3 @@ If you decide to host your own bots using my source code please consider using m - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) - [IEX Cloud](https://iexcloud.io/s/62c8503e) - - diff --git a/docs/telegram.md b/docs/telegram.md new file mode 100644 index 0000000..c2ef359 --- /dev/null +++ b/docs/telegram.md @@ -0,0 +1,24 @@ +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 92c1123..bc78e6b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,13 +3,14 @@ site_url: https://simple-stock-bots.gitlab.io/site edit_uri: /simple-stock-bots/site/tree/master/docs nav: - Home: index.md - - Author's Website: https://blog.ansonbiggs.com/ + - Telegram Commands: telegram.md + - Donate: donate.md - Contact (Email): mailto:anson@ansonbiggs.com - LICENSE: LICENSE.md theme: "material" repo_url: https://gitlab.com/simple-stock-bots repo_name: Simple Stock Bots -site_description: A collection of simple chat bots for Stock Market Data. -site_author: Anson Biggs -copyright: Anson Biggs 2018
All market data is provided by IEX Cloud \ No newline at end of file +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