first commit

README.md

@@ -0,0 +1,42 @@
+# Blitzortung Lightning Notifier
+
+This project connects to the Blitzortung lightning detection network and sends notifications to your devices when lightning strikes are detected near your specified location.
+
+## Features
+
+- Connects to Blitzortung's live WebSocket feed.
+- Filters lightning strikes by your chosen location and radius.
+- Sends rich notifications to your devices via [ntfy.sh](https://ntfy.sh/).
+- Optionally displays details about the detectors involved in each strike.
+
+## Usage
+
+### Prerequisites
+
+- Rust (edition 2021 or newer)
+- [ntfy.sh](https://ntfy.sh/) account or topic (no registration required)
+- Optionally, a `detectors.json` file for detector details
+
+### Build
+
+```sh
+cargo build --release
+```
+
+### Run
+
+```sh
+cargo run --release -- \
+    --center-lat <latitude> \
+    --center-lon <longitude> \
+    --ntfy <ntfy_topic> \
+    [--delta <radius>] \
+    [--detector-fetch]
+```
+
+## Detectors
+If you enable `--detector-fetch`, make sure you have a valid `detectors.json` file in the project directory. This file should contain metadata about Blitzortung detectors.
+
+## License
+
+MIT