Skip to content

Update CHANGELOG & README #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samhamilton merged 1 commit into from
Feb 14, 2025
Merged

Update CHANGELOG & README #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading