Skip to content

Commit 847f22e

Browse files
committed
Update readme and bump version to 0.4.0
1 parent f8db5cc commit 847f22e

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ module can, by default, only operate on datetimes in the UTC time zone. Alternat
88
third-party libraries, such as `tz`, to bring in time zone support and deal with datetimes in other time zones than UTC.
99

1010
The `tz` library relies on the [time zone database](https://data.iana.org/time-zones/tzdb/) maintained by
11-
[IANA](https://www.iana.org). As of version 0.3.0, `tz` uses version _tzdata2019c_ of the IANA time zone database.
11+
[IANA](https://www.iana.org). As of version 0.4.0, `tz` uses version _tzdata2019c_ of the IANA time zone database.
12+
13+
## Features
14+
15+
### Battle-tested
16+
17+
The `tz` library is tested against nearly 10 million past dates, which includes most of all possible imaginable
18+
edge cases.
19+
20+
### Pre-compiled time zone data into maps
21+
22+
Time zone periods are deducted from the [IANA time zone data](https://data.iana.org/time-zones/tzdb/). A period is a
23+
period of time where a certain offset is observed. Example: in Belgium, from 31 March 2019 until 27 October 2019, clock
24+
went forward by 1 hour; this means that during this period, Belgium observed a total offset of 2 hours from UTC time.
25+
26+
The time zone periods are computed and made available in Elixir maps during compilation time, to be consumed by the
27+
[DateTime](https://hexdocs.pm/elixir/DateTime.html#module-time-zone-database) module.
1228

1329
## Usage
1430

@@ -37,12 +53,11 @@ Add `tz` for Elixir as a dependency in your `mix.exs` file:
3753
```elixir
3854
def deps do
3955
[
40-
{:tz, "~> 0.3.0"}
56+
{:tz, "~> 0.4.0"}
4157
]
4258
end
4359
```
4460

4561
## HexDocs
4662

4763
HexDocs documentation can be found at [https://hexdocs.pm/tz](https://hexdocs.pm/tz).
48-

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule Tz.MixProject do
22
use Mix.Project
33

4-
@version "0.3.0"
4+
@version "0.4.0"
55

66
def project do
77
[

0 commit comments

Comments
 (0)