diff --git a/README.md b/README.md index ef951d2..73e9d31 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,25 @@ Copy the configuration file, make any necessary changes, and run: again * `delay`: time to wait after processing all rules before running the loop again + +## Database Schema + +`adsms` uses a SQLite database to store subscriptions and information about tracked aircraft. Currently, the only table is `subscriptions`. + +### `subscriptions` + +The `subscriptions` table has the following columns: + +| Column Name | Data Type | Description | +| ------------- | --------- | -------------------------------------------------------------- | +| `rowid` | INTEGER | Unique identifier for the subscription. | +| `phone` | TEXT | Phone number to receive notifications for this subscription. | +| `icao` | TEXT | ICAO address of the aircraft to track. | +| `description` | TEXT | Description of the aircraft being tracked. | +| `last_seen` | INTEGER | Timestamp of the last time this aircraft was seen by the system.| + +This table stores information about each subscription, including the phone number to send notifications to, the ICAO address of the aircraft to track, a description of the aircraft, and the last time it was seen by the system. + +## Use of ChatGPT + +Portions of both this README and the `adsms` code have been partially written with ChatGPT. \ No newline at end of file