mirror of
https://gitlab.com/simple-stock-bots/docs.git
synced 2025-06-16 15:17:27 +00:00
53 lines
2.7 KiB
Markdown
53 lines
2.7 KiB
Markdown
# Simple Stock Bots
|
|
|
|
[](https://t.me/SimpleStockBot)
|
|
[](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot)
|
|
[](https://tldrlegal.com/license/mit-license#summary)
|
|
|
|
---
|
|
|
|
## About
|
|
|
|
Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information. Currently there are only Telegram and Discord Bots.
|
|
|
|
## Getting Started
|
|
|
|
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 Bot :fontawesome-brands-telegram-plane:](https://t.me/SimpleStockBot){ .md-button .md-button--primary }
|
|
|
|
[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. For full information see [Commands](commands.md)
|
|
|
|
|
|
|
|
## Help the bot isn't working! / I have an amazing feature that you should totally add!
|
|
|
|
Feel free to reach out at any of the following places:
|
|
|
|
- Run the `/help` command and try to figure it out yourself.
|
|
- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
|
- 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 :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 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.
|
|
|
|
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
|
- [IEX Cloud](https://iexcloud.io/s/62c8503e)
|