Skip to content

Commit 89f5581

Browse files
committed
add ups to readme
1 parent 6644f5f commit 89f5581

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# iiPythonx / USPS
22

3-
A CLI for tracking packages from USPS.
3+
A CLI for tracking packages from USPS (with crude support for UPS packages).
44

55
### Installation
66

@@ -13,6 +13,9 @@ uv pip install git+https://github.com/iiPythonx/usps
1313

1414
### Usage
1515

16+
> [!IMPORTANT]
17+
> For UPS packages, USPS-cli only support the `1Z` version of UPS tracking numbers right now.
18+
1619
Get the tracking information for a package:
1720
```sh
1821
usps track 9400100000000000000000
@@ -47,10 +50,13 @@ Remove the name from a package:
4750
usps name --erase 9400100000000000000000
4851
```
4952

50-
For more details, run `usps --help`.
53+
For more details, run `usps --help`.
5154

5255
### Requirements
5356

57+
> [!NOTE]
58+
> If you **only** plan to track **UPS** packages, you can skip installing a selenium driver.
59+
5460
Since this package uses selenium for challenge solving, you'll need to install a [Firefox-compatible browser](https://www.mozilla.org/en-US/firefox) and [geckodriver](https://github.com/mozilla/geckodriver/releases).
5561
Feel free to modify the code to use Chromium instead if you prefer it.
5662

0 commit comments

Comments
 (0)