From 6e59b0b23972d033014ffdef9e6d7c95716075c7 Mon Sep 17 00:00:00 2001 From: HojouFotytu <36724681+HojouFotytu@users.noreply.github.com> Date: Tue, 4 Dec 2018 22:51:51 +0900 Subject: [PATCH] Initial Home page --- Home.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..cdafaec --- /dev/null +++ b/Home.md @@ -0,0 +1,49 @@ +## What is this? +_Profit Trailer Magic_ is a **powerful and free addon** for the cryptocurrency trading bot [Profit Trailer](http://www.profittrailer.com). + +This addon provides the following key features: +- Observe your trading markets for different timeframes +- Handle Profit Trailer settings based on market conditions +- Handle single market exceptions (for example to protect you from pump & dumps) +- Easy to use monitoring +- DCA calculator using your Profit Trailer settings +- Detailed analyzation of your sales + +See [how it works](https://github.com/Legedric/ptmagic/wiki/How-it-works) + +## Why are you doing all this for free? +Because we can. Yes, it is as simple as that. Well... and because we have fun developing software. + +## What do I need? +- [Profit Trailer](http://www.profittrailer.com) +- A computer to run Profit Trailer and PT Magic on + +**Important: Please do not install PTMagic if you are already running Profit Trailer Feeder.** Both addons write to your bot .PROPERTIES files and there may be side effects and the addons will conflict with each other! + +If you already use **Profit Trailer Feeder** and want **PT Magic** to act as an information dashboard only you can run it in Testmode. See [this](https://github.com/Legedric/ptmagic/issues/26) and [this](https://github.com/Legedric/ptmagic/issues/22). **PT Magic** then will only collect summary data for the dashboard but will NOT change your settings (that would be Feeders job). +However, please be aware that this may lead to errors firing from either addon or Profit Trailer itself. Although PT Magic won't write to files, it does read from them so in case for example PT Feeder is currently writing to a file that PT Magic wants to read from, it will trigger errors. + +## What exchanges are supported? +PT Magic is currently working on **Bittrex**, **Binance** and **Poloniex**. + +## How do I set it up? +Please follow the guide for your operating system. + +### Windows Setup (Recommended) +[Start here](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-Windows) + +### Linux Setup +[Start here](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-Linux) + +### MacOS Setup +[Start here](https://github.com/Legedric/ptmagic/wiki/Setup-PT-Magic-on-MacOS) + +## Do you offer support? +If you experience any issues or have any suggestions for PT Magic, feel free to [create an issue here on github](https://github.com/Legedric/ptmagic/issues) + +or visit the official PT magic Discord Channel: [https://discord.gg/KYmHMfk](https://discord.gg/KYmHMfk). + + +There is also a Spanish Telegram cummunity for PT Magic which you may find here: https://t.me/PTMagic + +There is also a Chinese Telegram cummunity for PT Magic which you may find here: https://t.me/PTMagicCN \ No newline at end of file