diff --git a/README.rst b/README.rst index 1dc87f7d..6c395b45 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ .. image:: https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg - :target: https://enigmampc.github.io/catalyst - :align: center + :target: https://enigmampc.github.io/catalyst + :align: center :alt: Enigma | Catalyst |version tag| diff --git a/docs/source/index.rst b/docs/source/index.rst index a0e8f097..3e94084f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,4 @@ -.. include:: welcome.rst +.. include:: ../../README.rst | | Table of Contents diff --git a/docs/source/welcome.rst b/docs/source/welcome.rst deleted file mode 100644 index 22bd37ff..00000000 --- a/docs/source/welcome.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. image:: https://s3.amazonaws.com/enigmaco-docs/enigma-catalyst.jpg -| -Catalyst is an algorithmic trading library for crypto-assets written in Python. -It allows trading strategies to be easily expressed and backtested against -historical data (with daily and minute resolution), providing analytics and -insights regarding a particular strategy's performance. Catalyst also supports -live-trading of crypto-assets starting with three exchanges (Bitfinex, Bittrex, -and Poloniex) with more being added over time. Catalyst empowers users to share -and curate data and build profitable, data-driven investment strategies. Please -visit `enigma.co `_ to learn more about Catalyst, or -refer to the `whitepaper `_ for -further technical details. - -Catalyst builds on top of the well-established -`Zipline `_ project. We did our best to -minimize structural changes to the general API to maximize compatibility with -existing trading algorithms, developer knowledge, and tutorials. Join us on -`Discord `_ where we have a *#catalyst_dev* channel -for questions around Catalyst, algorithmic trading and technical support. - -Features -======== - -- Ease of use: Catalyst tries to get out of your way so that you can - focus on algorithm development. See - `examples of trading strategies `_ - provided. -- Support for several of the top crypto-exchanges by trading volume: - `Bitfinex `_, `Bittrex `_, - and `Poloniex `_. -- Secure: You and only you have access to each exchange API keys for your accounts. -- Input of historical pricing data of all crypto-assets by exchange, - with daily and minute resolution. See - `Catalyst Market Coverage Overview `_. -- Backtesting and live-trading functionality, with a seamless transition - between the two modes. -- Output of performance statistics are based on Pandas DataFrames to - integrate nicely into the existing PyData eco-system. -- Statistic and machine learning libraries like matplotlib, scipy, - statsmodels, and sklearn support development, analysis, and - visualization of state-of-the-art trading systems. -- Addition of Bitcoin price (btc_usdt) as a benchmark for comparing - performance across trading algorithms. \ No newline at end of file