aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b9c3fb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# express-ru-tracker
+
+Скрипт для проверки обновлений по отслеживанию посылок Express.Ru.
+
+Отправляет обновления в Telegram.
+
+## Usage
+
+1. Установить зависимости через composer.
+
+2. Запускать через cron как-то так:
+ ```
+ php track.php \
+ --tracking-number D123456 \
+ --tracking-date 2021-05-20 \
+ --user-login $USER_LOGIN \
+ --user-signature-key $USER_SIGNATURE_KEY \
+ --user-authorization-key $USER_AUTHORIZATION_KEY \
+ --telegram-chat-id $CHAT_ID \
+ --telegram-token $TOKEN
+ ```
+
+## License
+
+MIT \ No newline at end of file