From 42b60cf56b7438dab91dd23cc3a05e7d696107cc Mon Sep 17 00:00:00 2001 From: Kumi Date: Fri, 25 Aug 2023 07:39:11 +0200 Subject: [PATCH] Update Usage section in README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10b62e9..b46afd4 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,15 @@ Then copy `config.dist.ini` to `config.ini` and fill in your KeyDelivery API det ## Usage -To add a new shipment, run `python trackbert.py --tracking-number --carrier `. Find the required carrier ID in the [KeyDelivery API management](https://app.kd100.com/api-management). +First, assure that the virtual environment is activated: -To run the main loop, run `python trackbert.py`. This will check the status of all shipments every 5 minutes, and print the status to the console. If the status of a shipment changes, you will get a desktop notification. +```bash +source venv/bin/activate +``` + +To add a new shipment, run `trackbert --tracking-number --carrier `. Find the required carrier ID in the [KeyDelivery API management](https://app.kd100.com/api-management). + +To run the main loop, run `trackbert`. This will check the status of all shipments every 5 minutes, and print the status to the console. If the status of a shipment changes, you will get a desktop notification. ## License