initial version

README.md

@@ -0,0 +1,56 @@
+# Warning / Disclaimer
+The software provided here does not guarantee any profits or function as well as sufficient security. Use at your own risk!!!
+This is a private project, which is based on amateur knowledge. Trading cryptocurrencies involves an enormous amount of risks and is considered highly speculative. 
+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 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.
+
+# Features
+## General:
+- Compatible with the following crypto exchanges: Binance
+- 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
+- Notifications via Signal Messenger to groups
+- Individually selectable percentage of available capital per trade
+- automatic definition of time intervals (e.g. every minute / every five minutes) based on the change of the rates
+- Monitoring of overall market performance via own market performance index based for example on the MACI World, leading currencies like BTC and ETH and their forecasts. 
+- Emergency stop if balance falls below defined value
+- Recording of available price values incl. RSI and MACD indicators of available cryptocurrencies
+- Analysis tool for collected historical values to try out buy or sell conditions based on them 
+- ReadOnly web interface for overview
+
+## Buy conditions
+- definable RSI Indicator signals min/max (RSI5, 14 and 21)
+- definable MACD signals min/max
+- definable minimum growth in a definable time period
+
+## Sell conditions
+- sell at defined loss limit
+- hold if the result would be negative
+- sell after certain time even if loss exists
+- definable RSI Indicator signals min/max
+- definable MACD signals min/max
+
+# How to use/install
+Linux knowledge required!
+
+Download:
+```
+git clone https://gitea.ds9.dedyn.io/olli/Cryptocurrencies.git
+cd Cryptocurrencies
+```
+bot.sh is the bot that trades and collects the quotes and analyze.sh is the tool with which you can try out strategies with the historical data.
+The configuration files are called bot.conf and analyze.conf. analyze.sh also uses bot.conf but its variables are overwritten by analyze.conf if duplicated.
+
+A Binance account must exist and the API must be enabled.
+The access data is stored in the file .binance-secrets in the project directory in the variables API_SECRET and API_KEY.
+The access rights to this file should be set to the minimum necessary for security reasons.
+
+# Future ideas/featrues
+- Crypto preferences (While/Blacklist for certain currencies)
+- Overview trades/profits/losses for tax declaration
+- Support for additional exchanges (currently only Binance)
+- Support for decentralized exchanges like uniswap to gain more "security"
+