doc

README.md

@@ -4,7 +4,10 @@ This is a private project, which is based on amateur knowledge. Trading cryptocu
 It is strongly recommended to deal intensively with the subject and this bot before using it. Also, when using the possibility should be considered that due to an unfavorable market development, technical errors, bugs or other reasons, the entire invested capital can be lost. This software should therefore only be used if it is justifiable to lose the entire invested capital!
 
 # Objective
-The dabo-bot is intended to help make and execute timely buy and sell decisions automatically in the fast-paced crypto environment. It is to be invested in the case of larger increases in value and investments are to be sold again when the prices fall, so that price gains are taken and losses are minimized.
+The dabo-bot is intended to help make and execute timely buy and sell decisions automatically in the fast-paced crypto environment.
+
+These decisions are made using one or more self-definable strategies.
+Various market data are available as a basis for decision-making, such as price trends, RSI, MACD and EMA indicators of various time intervals, Fear and Greed Index, S&P500 data,... 
 
 # Naming
 The name Dabo comes from the Star Trek universe.
@@ -13,9 +16,34 @@ More information here:
 https://memory-alpha.fandom.com/wiki/Dabo
 I thought this fits quite well to the cryptotrading world and that's why I chose this name ;-)
 
+# Structure
+The Bot is splitted in the following parts:
+
+- dabo-bot: Basic Bot woth buy and sell decisions based on self-definable strategies
+- dabo-symbols_ticker: Ticker for current symbols and prices
+- dabo-ohlcv-candles: Continuously collect OHLCV data
+- dabo-indicators: Continuously calculate indicators and other data
+- dabo-orders: Continuously collect current orders placed by bot and others
+- dabo-transaction-history: Continuously creates overview of historic trades
+- dabo-webpage: Continuously creates webpage overview (readonly)
+- dabo-web: Webserver for webpage overview
+
+For cummunicating with the exchange APIs CCXT is used: https://github.com/ccxt/ccxt
+Each part runs parallel to the others in its own docker-container.
+
 # Features
 ## General:
-- Compatible with the following crypto exchanges: Binance, OneTrading.com (ex BitpandaPro)
+- theoretically compatible to supported CCXT exchanges.
+- parallel processing in separate docker containers
+
+## Dabo Bot
+## Dabo Symbol Tticker
+## Dabo OHLCV Candles
+## Dabo Indicators
+## Dabo Orders
+## Dabo Transaction History
+## Dabo Webpage
+
 - Consideration of trading fees
 - Automatic selection of cryptocurrencies to invest in
 - Filtering of cryptocurrencies by market capitalization (data via coingecko API) e.g. only trade the 50 largest by market capitalization if available on the exchange
@@ -44,6 +72,14 @@ I thought this fits quite well to the cryptotrading world and that's why I chose
 - definable RSI Indicator signals min/max
 - definable MACD signals min/max
 
+# Why bash?
+Yes, bash is not a language in which you write something like this in a normal way.
+To be honest, I'm more of a Linux admin than a programmer, so I do a lot of my work using bash.
+Simply it's the language I'm most familiar with.
+Originally this project was supposed to be a simple script to monitor prices of equities and ETFs and set alarms at certain marks. Over time it has expanded a lot and a complete rewrite in another language would have meant a lot of additional work. So it has stayed that way until now.
+Finally, it's a hobby project and I have to see how and when I can find time for it.
+If there is someone who would like to rewrite this bot in e.g. Python, I would be happy to support them as best I can with this task. Just let me know.
+
 # How to use/install
 Linux knowledge required!