diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c31ad7..4807ae4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [Unreleased] + +- Update README +- Update airports & timezone csv by running `mix airports.update` +- Auto download source file when running `mix airports.update` +- Bump dependencies: `excoveralls`, `castore`, `ex_doc`, and `dialyxir` + ## 1.0.0 - **Breaking change:** Swapped to new airports datasource as old has not been [updated since 2019](https://github.com/jpatokal/openflights/commits/master/data/airports.dat) where as the new source (which is listed on the openflights website) is [updated daily(!)](https://github.com/davidmegginson/ourairports-data/commits/main/airports.csv) diff --git a/README.md b/README.md index fe65b6c..922dce1 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,16 @@ def deps do end ``` -## Adding timezone to the Airports data +## Updating airports data with timezone -Airports depends on [tz_world](https://github.com/kimlai/tz_world) for timezone data. After updating `priv/airports.csv`, run the following to add timezone data: +Airports depends on [tz_world](https://github.com/kimlai/tz_world) for timezone data. Update airports and timezone data by running the following command: ```elixir mix airports.update ``` +This command will automatically download the latest airports data from the data source, put timezone data for each airport, and save it to `priv/airports.csv` and `priv/airports_with_tz.csv` respectively. + ## Contributing Before opening a pull request, please open an issue first.