From 75d5f59a6fceb582318d51e300f29a212f54c7bb Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Wed, 5 Aug 2020 11:10:50 +0200 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++------------------------- 1 file changed, 10 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 2472648d3..f3e78539d 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,26 @@ -# Contact Us +# Get in Touch -Please join our Telegram Community to contact us there: https://t.me/superalgoscommunity +Touch base with the Community and talk to the admins in our [Community Telegram](https://t.me/superalgoscommunity). # Superalgos -Superalgos provides a toolbox with many integrated tools that could help you research crypto markets and design / automate trading strategies. You can use Superalgos to download market data from crypto exchanges, make arbitrary calculations with it (including indicators), plot the results of your calculations, design, test and automate trading strategies, and more. +Superalgos provides a toolbox with several integrated tools to design, test, and deploy automated crypto trading strategies, as well as research crypto markets. You can use Superalgos to download market data from crypto exchanges, make arbitrary calculations (including indicators), plot the results of your calculations over the charts, design trading strategies in a visual scripting environment that does not require coding, while still empowering developers by allowing it, and more. -You can do any of the above individually or alltogether plus reuse all information gathered and generated (standarized in multiple time frames, stored at text files by exchange/market) as an input for your own software / systems. Superalgos runs at your computer, it is free and open source. +You may use individual features or the whole package, and reuse all information gathered and generated—standardized in multiple time frames, stored in text files sorted by exchange/market—as input for your own software/systems. + +Superalgos runs on your computer, it is free and open source. ![Superalgos video capture (16)](https://user-images.githubusercontent.com/9479367/77251218-76d25980-6c4d-11ea-8e47-be7db2e8abdb.gif) -## Documentation +## Documentation & FAQs Please refer to the [documentation site](https://docs.superalgos.org/). -## Exchange Testing Queue - -The current version opens up the door to working with multiple exchanges and multiple markets. For your reference, this is a quick report on the progress of our tests: - -| Exchange | Historic OHLCVs Capability [*] | Trading Capability [**] | Comments | -| :--- | :---: | :---: | :---: | -| Binance | ☑ | ☑ | Fully tested. Market history from Sep 2017. | -| Bitfinex | ☑ | ☑ | Fully tested. Expect 1 year max of market history. | -| Bitmex | ☑ | ☐ | We need to implement the concept of Contracts within the system in order to be able to test trading capabilities. | -| HitBTC | ☐ | ☐ | Not tested yet. | -| Kraken | ☐ | ☐ | Historical data only accessed by id (not by date). Live trading not tested yet. | -| Poloniex | ☐ | ☐ | At the moment we can not retrieve OHLCVs from Poloniex because we require 1 minute time frame while Poloniex only offers 5 minutes and above. | -| Bittrex | ☑ | ☐ | Only 6 Months of historical data is provided. Live trading not available because Bittrex allows limit orders only and Superalgos is placing only market orders for now. | -| Gemini | ☑ | ☐ | Only a few hours of historical data is provided. Live trading not tested yet. | - -[*] The ability to fetch historic data for backtesting purposes has been verified. - -[**] The ability to run strategies in live-trading mode has been verified. - ## Contributing -We'd love you to join us in the Dev Team. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for the details on how to engage with it. +Your help may be essential to the project's success and we want you in! + +[There is something you may do](https://docs.superalgos.org/contributing-to-superalgos.html) to help the project regardless of what your skillset may be. We appreciate all contributions! ## License