diff --git a/README.md b/README.md index c0e3117aa..b5761eb1b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Superalgos Platform -The Superalgos Platform provides a visual environment for developing, testing and automating crypto-trading strategies as well as processing markets data and building indicators. +The Superalgos Platform provides a visual environment for developing, testing and automating crypto-trading strategies as well as processing market data and building indicators. ![Illustration](https://user-images.githubusercontent.com/13994516/63528460-4550ae80-c503-11e9-8db6-22995e0b9c16.gif) ## Testing Exchanges -The version in development 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: +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 Data Capability [*] | Trading Capability [**] | | :--- | :---: | :---: | @@ -23,19 +23,21 @@ The version in development opens up the door to working with multiple exchanges ## Documentation -The [Users Manual](https://github.com/Superalgos/Platform/wiki) in this repository's wiki features the documentation corresponding to the latest release. +Please refer to the [new documentation site](https://docs.superalgos.org/). -A [new documentation site](https://superalgos.github.io/Documentation/) is in the making, covering the functionality in development. +Developers testing the version in the ```develop``` branch may consult the [develop documentation version](https://superalgos.github.io/Documentation/). This version of the docs is in a permanent work-in-progress state. ## Codebase and Development Environment To build each release, the Superalgos Platform used to draw code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. This has changed. -The ```develop``` branch in this repository now features the latest codebase and development environment. +The ```develop``` branch in this repository now features the latest codebase and development environment. -The codebase is distributed with the platform's release, and constitutes a fully functional development environment right out of the package. The platform runs uncompilled on the actual code (```node run``` from the root folder). +The ```master``` branch in this repository now features the latest stable version of Superalgos. -> If you are testing the version in development, you need to use the workspace in the root directory. Workspaces of older versions do not work in the new one. +The codebase is distributed with the platform's release and constitutes a fully functional development environment right out of the package. The platform runs uncompiled on the actual code (```node run``` from the root folder). + +> Use the workspace in the root directory. Workspaces of older versions do not work in the new one. if you are upgrading from an old version, make sure you make a hard refresh of your browser's cache before importing the new workspace. ## Contributing