From cd8610cb2456b60bef31381fb9c999dade7a5738 Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 22 Oct 2020 07:50:09 +0200 Subject: [PATCH] Update readme.md files --- README.md | 29 ++++++++++++++--------------- docs/index.md | 10 ++++++---- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4290dec8f..c9f4d0a52 100644 --- a/README.md +++ b/README.md @@ -110,17 +110,17 @@ optional arguments: Telegram is not mandatory. However, this is a great way to control your bot. More details and the full command list on our [documentation](https://www.freqtrade.io/en/latest/telegram-usage/) -- `/start`: Starts the trader -- `/stop`: Stops the trader -- `/status [table]`: Lists all open trades -- `/count`: Displays number of open trades +- `/start`: Starts the trader. +- `/stop`: Stops the trader. +- `/stopbuy`: Stop entering new trades. +- `/status [table]`: Lists all open trades. - `/profit`: Lists cumulative profit from all finished trades - `/forcesell |all`: Instantly sells the given trade (Ignoring `minimum_roi`). - `/performance`: Show performance of each finished trade grouped by pair -- `/balance`: Show account balance per currency -- `/daily `: Shows profit or loss per day, over the last n days -- `/help`: Show help message -- `/version`: Show version +- `/balance`: Show account balance per currency. +- `/daily `: Shows profit or loss per day, over the last n days. +- `/help`: Show help message. +- `/version`: Show version. ## Development branches @@ -132,16 +132,15 @@ The project is currently setup in two main branches: ## Support -### Help / Slack +### Help / Slack / Discord -For any questions not covered by the documentation or for further -information about the bot, we encourage you to join our slack channel. +For any questions not covered by the documentation or for further information about the bot, we encourage you to join our slack channel. - [Click here to join Slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LTU1MTgxMjkzNmYxNWE1MDEzYzQ3YmU4N2MwZjUyNjJjODRkMDVkNjg4YTAyZGYzYzlhOTZiMTE4ZjQ4YzM0OGE). -To those interested to check out the newly created discord channel. Click [here](https://discord.gg/MA9v74M) +Alternatively, check out the newly created [discord server](https://discord.gg/MA9v74M). -P.S. currently since discord channel is relatively new, answers to questions might be slightly delayed as currently the user base quite small. +*Note*: Since the discord server is relatively new, answers to questions might be slightly delayed as currently the user base quite small. ### [Bugs / Issues](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue) @@ -169,7 +168,7 @@ Please read our [Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) to understand the requirements before sending your pull-requests. -Coding is not a neccessity to contribute - maybe start with improving our documentation? +Coding is not a necessity to contribute - maybe start with improving our documentation? Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase. **Note** before starting any major new feature work, *please open an issue describing what you are planning to do* or talk to us on [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LTU1MTgxMjkzNmYxNWE1MDEzYzQ3YmU4N2MwZjUyNjJjODRkMDVkNjg4YTAyZGYzYzlhOTZiMTE4ZjQ4YzM0OGE). This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it. @@ -180,7 +179,7 @@ Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/ ### Up-to-date clock -The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges. +The clock must be accurate, synchronized to a NTP server very frequently to avoid problems with communication to the exchanges. ### Min hardware required diff --git a/docs/index.md b/docs/index.md index b2f3e417e..5608587db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,15 +59,17 @@ Alternatively ## Support -### Help / Slack +### Help / Slack / Discord + For any questions not covered by the documentation or for further information about the bot, we encourage you to join our passionate Slack community. Click [here](https://join.slack.com/t/highfrequencybot/shared_invite/enQtNjU5ODcwNjI1MDU3LTU1MTgxMjkzNmYxNWE1MDEzYzQ3YmU4N2MwZjUyNjJjODRkMDVkNjg4YTAyZGYzYzlhOTZiMTE4ZjQ4YzM0OGE) to join the Freqtrade Slack channel. -To those interested to check out the newly created discord channel. Click [here](https://discord.gg/MA9v74M) +Alternatively, check out the newly created [discord server](https://discord.gg/MA9v74M). -P.S. currently since discord channel is relatively new, answers to questions might be slightly delayed as currently the user base quite small. +!!! Note + Since the discord server is relatively new, answers to questions might be slightly delayed as currently the user base quite small. ## Ready to try? -Begin by reading our installation guide [for docker](docker.md), or for [installation without docker](installation.md). +Begin by reading our installation guide [for docker](docker.md) (recommended), or for [installation without docker](installation.md).