Skip to content

Commit a72c903

Browse files
committed
Update readme
1 parent e6419e2 commit a72c903

File tree

1 file changed

+18
-58
lines changed

1 file changed

+18
-58
lines changed

README.md

Lines changed: 18 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,30 @@
1-
# Investing bot
1+
# Investing Algorithm Framework
22

3-
The investing bot is a free and open source investing bot written in Python. The goal is to give you a configurable bot
4-
where you can decide on how you implement your data providers, strategies, and brokers/exchanges. Also we want to allow
5-
you to let your bot facilitate multiple users.
3+
The Investing Algorithm Framework is a free and open source Python framework that encourages rapid development and clean,
4+
pragmatic design.
65

7-
It is designed to be controlled via Telegram. As of now, we are aiming to make the configuration of the different
8-
components by the use of plugins. Please see the documentation on how to make your own plugin.
6+
The goal is to give you a configurable investing algorithm where you can decide how you implement your data providers,
7+
strategies, and order executors.
98

10-
### Disclaimer
11-
This software is for educational purposes only. Do not risk money which you are afraid to lose. We can't stress this
12-
enough: BEFORE YOU START USING MONEY WITH THE BOT, MAKE SURE THAT YOU TESTED YOU STRATEGIES AND DATA PROVIDERS.
13-
USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
9+
#####Disclaimer
10+
If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this
11+
enough:
1412

15-
Always start by running a investing bot in Dry-run and do not engage money before you understand how it works and what profit/loss you should expect.
16-
17-
We strongly recommend you to have coding and Python knowledge, or trust the people that created the plugins your using.
18-
Do not hesitate to read the source code and understand the mechanism of this bot or the plugin you're using.
19-
20-
Brokers/Exchange marketplaces supported
21-
------
22-
Will be updated in the future
13+
BEFORE YOU START USING MONEY WITH THE FRAMEWORK, MAKE SURE THAT YOU TESTED YOUR COMPONENTS THOROUGHLY. USE THE SOFTWARE AT
14+
YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR INVESTMENT RESULTS.
2315

16+
Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this
17+
framework.
2418

2519
Documentation
2620
------
27-
Will be updated in the future
28-
29-
## Features
30-
31-
- [x] **Based on Python 3.6+**: Support for all operating systems - Windows, macOS and Linux.
32-
- [x] **Persistence**: Persistence is achieved through sqlite.
33-
- [ ] **Dry-run**: Run the bot without playing money.
34-
- [ ] **REST API**: Manage the bot with the use of a REST API.
35-
- [ ] **Backtesting**: Run a simulation of your buy/sell strategy.
36-
- [ ] **Manageable via Telegram**: Manage the bot with Telegram.
37-
- [ ] **Display profit/loss**: Display your profit/loss.
38-
- [ ] **Daily summary of profit/loss**: Provide a daily summary of your profit/loss.
39-
- [ ] **Performance status report**: Provide a performance status of your current trades.
40-
41-
## Quick start
42-
43-
The investing bot provides a Linux/macOS script to install all dependencies and help you to configure the bot.
44-
45-
The script will come as a future update
46-
47-
### Bot commands
48-
49-
50-
```
51-
usage: main.py [-h] [-V] [-c PATH]
52-
53-
Trading bot based on value principles
54-
55-
optional arguments:
56-
-h, --help show this help message and exit
57-
-V, --version show program's version number and exit
58-
-c PATH, --config PATH
59-
Specify configuration file (default: `config.json`).
60-
61-
```
62-
63-
### Telegram RPC commands
64-
65-
Telegram is not mandatory. However, this is a great way to control your bot.
21+
All documentation is in the "docs" directory and online at "". If you're just getting started, here's how we recommend
22+
you read the docs:
6623

24+
* First, read install for instructions on installing Investing Algorithm Framework.
25+
* Next, work through the tutorials in order. ("Quickstart", "Template algorithm", "Custom algorithm").
26+
* For concrete algorithm examples you probably want to read through the topical guides.
27+
6728

6829
## Development branches
6930

@@ -74,7 +35,6 @@ The project is currently setup in two main branches:
7435
- `feature/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.
7536
- `hotfix/*` - These are hot fix branches, which are being worked on heavily. Please don't use these unless you really need to.
7637

77-
## Support
7838

7939
### Help / Slack
8040

0 commit comments

Comments
 (0)