Skip to content

Commit 95260ef

Browse files
committed
docs: update README with Gmail setup and check command usage
1 parent 6d604e7 commit 95260ef

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,26 @@ CLI tool to check for recent snowy owl observations using the eBird API.
99

1010
Get an API key by signing up at https://ebird.org/api/keygen.
1111

12+
For email alerts, set up Gmail SMTP credentials:
13+
14+
export GMAIL_USER=you@gmail.com
15+
export GMAIL_APP_PASSWORD=your-app-password
16+
17+
Generate an app password at https://myaccount.google.com/apppasswords (requires 2FA).
18+
1219
## Usage
1320

14-
uv run snowy
21+
List recent sightings:
22+
23+
uv run snowy sightings
1524

1625
Defaults to Salem, MA with a 30-mile radius over the last 14 days. Override with options:
1726

18-
uv run snowy --lat 40.71 --lng -74.01 --dist 50 --days 30
27+
uv run snowy sightings --lat 40.71 --lng -74.01 --dist 50 --days 30
28+
29+
Check for new sightings and send email alerts:
30+
31+
uv run snowy check --to "you@gmail.com,spouse@gmail.com"
1932

2033
## eBird API
2134

0 commit comments

Comments
 (0)