diff --git a/docs/commands.md b/docs/commands.md index 90c3c90..e5fb6da 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -29,7 +29,7 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock # `/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. +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.md) page for more information.
@@ -45,7 +45,7 @@ The donate command is used to send money to the bot to help keep it free. The pr # `/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) +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.md)
diff --git a/docs/donate.md b/docs/donate.md index 8f4ad3d..217be44 100644 --- a/docs/donate.md +++ b/docs/donate.md @@ -12,3 +12,15 @@ You can also support the bot indirectly by using the following referal links: - [IEX Cloud](https://iexcloud.io/s/62c8503e) If you have any questions get in touch: [anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/) + + +## Support the Project + +If you appreciate these bots please consider [donating](donate.md) 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: + +- [_"buy me a coffee"_](https://www.buymeacoffee.com/Anson) +- Use my referral links when hosting your own bot. [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) or [IEX Cloud](https://iexcloud.io/s/62c8503e) +- Follow me on [twitter](https://twitter.com/Anson_3D) +- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index a71c1c4..1182d48 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,50 +14,19 @@ Simple Stock Bots is a family of messaging bots that aim to provide simple inter The bots can either be added to a server or can be direct messaged for the exact same functionality. Links for each platform are below: -- [Telegram](https://t.me/SimpleStockBot) -- [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) +[Telegram Bot :fontawesome-brands-telegram-plane:](https://t.me/SimpleStockBot){ .md-button .md-button--primary } -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) +[Discord Bot :fontawesome-brands-discord:](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot){ .md-button .md-button--primary } + + + +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.md) ## 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. +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. For full information see [Commands](commands.md) -- `/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. 🆘 -Please see [Commands](#commands) for detailed usage. - -### Universal Commands - -- /dividend `$[symbol]` will return dividend information for the symbol. -- /news `$[symbol]` will return news about the symbol. -- /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 Features - -For the full list of Telgram bot features see [Telegram Commands](./telegram) - ---- - -## Support the Project - -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: - -- [_"buy me a coffee"_](https://www.buymeacoffee.com/Anson) -- Use my referral links when hosting your own bot. [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) or [IEX Cloud](https://iexcloud.io/s/62c8503e) -- Follow me on [twitter](https://twitter.com/Anson_3D) -- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star ## Help the bot isn't working! / I have an amazing feature that you should totally add! @@ -68,14 +37,14 @@ Feel free to reach out at any of the following places: - Message me on [Telegram](https://t.me/MisterBiggs) - Message me on Discord `MisterBiggs#0465` - Assume someone else is already messaging me -- [Send a Carrier Pigeon 🕊 \(Twitter\)](https://twitter.com/Anson_3D) +- [Send a Carrier Pigeon :dove: \(Twitter\)](https://twitter.com/Handsome__Anson) ## Source Code The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. The full text of the license can be read [here](./LICENSE) -- [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) -- [Discord](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot) +- [Telegram Bot Source](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) +- [Discord Bot Source](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot) If you decide to host your own bots using my source code please consider using my referral links for DigitalOcean and IEX Cloud. We both get a kickback when you use them. diff --git a/mkdocs.yml b/mkdocs.yml index 8574bb1..2d442ad 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,20 @@ site_name: Simple Stock Bot Docs site_url: https://docs.simplestockbot.com edit_uri: /simple-stock-bots/site/tree/master/docs +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
Available Under an MIT LICENSE
All market data is provided by IEX Cloud + + nav: - Home: index.md - Commands: commands.md - Hosting: host.md - Donate: donate.md - - Contact: contact.md - - LICENSE: LICENSE.md + # - Contact: contact.md theme: name: "material" @@ -17,21 +24,18 @@ theme: logo: material/robot-love palette: - media: "(prefers-color-scheme: light)" + primary: green scheme: default toggle: icon: material/lightbulb-outline name: Switch to dark mode - media: "(prefers-color-scheme: dark)" + primary: green scheme: slate toggle: icon: material/lightbulb name: Switch to light mode -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
Available Under an MIT LICENSE
All market data is provided by IEX Cloud extra_css: - stylesheets/phone.css @@ -43,6 +47,7 @@ markdown_extensions: - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg + - attr_list plugins: - search