Skip to content

Commit

Permalink
#83 readmes were updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim55667757 committed Nov 21, 2022
1 parent 6b0fb9f commit 97db2c5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TKSBrokerAPI — платформа для автоматизации торгов на бирже
# TKSBrokerAPI — платформа для автоматизации торговли на бирже

**[TKSBrokerAPI](https://github.com/Tim55667757/TKSBrokerAPI)** — это платформа для упрощения автоматизации торговых сценариев на Python и работы с [Tinkoff Invest API](http://tinkoff.ru/sl/AaX1Et1omnH) сервером через REST-протокол. Платформа TKSBrokerAPI может использоваться в двух вариантах: из консоли (она имеет богатый набор ключей и команд) или её можно использовать как обычный Python модуль через `python import`. TKSBrokerAPI помогает автоматизировать рутинные торговые операции и реализовать торговые сценарии, или упростить получение необходимой для аналитики информации с сервера брокера. Платформа достаточно легко интегрируется в различные CI/CD конвейеры.

Expand Down Expand Up @@ -378,6 +378,8 @@ https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README.md
False по умолчанию.
--output OUTPUT Параметр: строка, которая заменяет стандартный путь вывода в файл
для некоторых команд. Если `None`, тогда используется стандартный путь.
--html, --HTML Параметр: если этот ключ задан, то платформа TKSBrokerAPI дополнительно
генерирует HTML-отчёт из Markdown-отчёта. False по умолчанию.
--interval INTERVAL Параметр: доступные значения равны `1min`, `5min`, `15min`,
`hour` и `day`. Используется только с ключом `--history`.
Это временной промежуток одной ценовой свечи. По умолчанию: `hour`.
Expand Down
4 changes: 3 additions & 1 deletion README_EN.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TKSBrokerAPI. The platform for automation trading scenarios
# TKSBrokerAPI Trade Automation Platform

**[TKSBrokerAPI](https://github.com/Tim55667757/TKSBrokerAPI)** is the trading platform for automation and simplifying the implementation of trading scenarios, as well as working with [Tinkoff Invest API](http://tinkoff.ru/sl/AaX1Et1omnH) server via the REST protocol. The TKSBrokerAPI platform may be used in two ways: from the console, it has a rich keys and commands, or you can use it as Python module with `python import`. TKSBrokerAPI allows you to automate routine trading operations and implement your trading scenarios, or just receive the necessary information from the broker. It is easy enough to integrate into various CI/CD automation systems.

Expand Down Expand Up @@ -381,6 +381,8 @@ options:
default.
--output OUTPUT Option: replace default paths to output files for some
commands. If `None` then used default files.
--html, --HTML Option: if key present then TKSBrokerAPI generate also
HTML reports from Markdown. False by default.
--interval INTERVAL Option: available values are `1min`, `5min`, `15min`,
`hour` and `day`. Used only with `--history` key. This
is time period of one candle. Default: `hour` for
Expand Down

0 comments on commit 97db2c5

Please sign in to comment.