Anson/Simple-Stock-Bot-Docs
1
0
Fork 0
mirror of https://gitlab.com/simple-stock-bots/docs.git synced 2025-06-16 07:16:39 +00:00
Code Releases Activity

tons of updates

Browse Source
This commit is contained in:
Anson 2020-03-28 23:43:43 -07:00
parent ed9bcefa6b
commit 6a60bb06b3
3 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/commands.md
View File

@ -20,8 +20,8 @@ Will return:
## Commands ## Commands
* [`/help`](#/help) - Create a new project. - [`/help`](#/help) - Create a new project.
* [`/news`](#/news) - Start the live-reloading docs server. - [`/news`](#/news) - Start the live-reloading docs server.
### /help ### /help
@ -29,16 +29,8 @@ This command just displays a short description of what the bot does and a link t
### /news ### /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. The bot will then return the price of the ticker, and links various websites that provide news about the ticker. Currently for Apple stock the Bot would return: 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._
`The current stock price of Apple Inc. is **$174.18**, the stock is currently up **1.71%**` [All market data is provided by IEX Cloud](https://iexcloud.io)
[`Bravos`](https://bravos.co/AAPL)
[`Seeking Alpha`](https://seekingalpha.com/symbol/AAPL)
[`MSN Money`](https://www.msn.com/en-us/money/stockdetails?symbol=AAPL)
[`Yahoo Finance`](https://finance.yahoo.com/quote/AAPL)
[`Wall Street Journal`](https://quotes.wsj.com/AAPL)
[`The Street`](https://www.thestreet.com/quote/AAPL.html)
[`Zacks`](https://www.zacks.com/stock/quote/AAPL)
*This command needs updating, feel free to [open an issue](https://gitlab.com/MisterBiggs/simple-telegram-bot/issues) with suggestions.*

36
docs/index.md
View File

@ -1,30 +1,32 @@
# Simple Stock Bots # Simple Stock Bots
[![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://telegram.org/)
[![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
## Table of Contents [![Platform](https://img.shields.io/badge/platform-Telegram-blue.svg)](https://t.me/SimpleStockBot)
+ [About](#about) [![Platform](https://img.shields.io/badge/platform-Discord-blue.svg)](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot)
+ [Getting Started](#getting_started) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://tldrlegal.com/license/mit-license#summary)
+ [Usage](#usage)
+ [Contributing](../CONTRIBUTING.md) ## About
## About <a name = "about"></a>
Simple Stock Bots is a family of messaging bots that aim to provide simple bots that provide information on the stock market. Currently there are only [Telegram](./telegram) and [Discord](./discord) Bots. Simple Stock Bots is a family of messaging bots that aim to provide simple bots that provide information on the stock market. Currently there are only [Telegram](./telegram) and [Discord](./discord) Bots.
## Getting Started <a name = "getting_started"></a> ## Getting Started
The simplest way to use these bots is to use the version that I host on Digital Ocean. You can find the links to access them below: The simplest way to use these bots is to use the version that I host on Digital Ocean. You can find the links to access them below:
+ [Telegram](https://t.me/SimpleStockBot) - [Telegram](https://t.me/SimpleStockBot)
+ [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) - [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.
## Source Code ## Source Code
The source code for the bots is completely open and hosted on Gitlab. The source code for the bots is completely open and hosted on GitLab.
+ [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-bot) - [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot)
+ [Discord](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot) - [Discord](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)
[All market data is provided by IEX Cloud](https://iexcloud.io)

6
mkdocs.yml
View File

@ -3,9 +3,11 @@ site_url: https://simple-stock-bots.gitlab.io/site
edit_uri: /simple-stock-bots/site/tree/master/docs edit_uri: /simple-stock-bots/site/tree/master/docs
nav: nav:
- Home: index.md - Home: index.md
- Telegram: telegram.md # - Telegram: telegram.md
- Discord: discord.md # - Discord: discord.md
- Commands: commands.md
- Author's Website: https://blog.ansonbiggs.com/ - Author's Website: https://blog.ansonbiggs.com/
- Contact (Email): mailto:anson@ansonbiggs.com
- LICENSE: LICENSE.md - LICENSE: LICENSE.md
theme: "material" theme: "material"