Skip to content

Commit 155b428

Browse files
committed
update readme a bit
1 parent a27ecb2 commit 155b428

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/timezone/)
66
-->
77

8+
This package can be used to load the timezone database from the standard location
9+
(`/usr/share/zoneinfo`) on MacOS and Linux computers. It includes a parser for
10+
the `tzfile` format, as well as a utility functions to convert a timestamp from
11+
the [gleam_time](https://hexdocs.pm/gleam_time/) library into a date and time
12+
of day in the given timezone.
13+
814
> We could really do with a timezone database package with a
915
> fn(Timestamp, Zone) -> #(Date, TimeOfDay) function
1016
>
@@ -15,15 +21,17 @@ To use, add the following entry in your `gleam.toml` file dependencies:
1521
```
1622
timezone = { git = "git@github.com:devries/timezone.git", ref = "main" }
1723
```
24+
# Installing the zoneinfo data files
1825

19-
A timezone library which uses your local ZONEINFO files to convert
20-
`timestamp.Timestamp` values into dates and times of day.
26+
## MacOS
27+
The files should be included in your operating system by default. Check the
28+
`/usr/share/zoneinfo` directory and see if they are present.
2129

22-
Further documentation can be found at <https://hexdocs.pm/timezone>.
30+
## Ubuntu/Debian Linux Systems
2331

24-
## Development
32+
## Alpine Linux Systems
2533

26-
```sh
27-
gleam run # Run the project
28-
gleam test # Run the tests
29-
```
34+
## Red Hat/Rocky/Alma Linux Systems
35+
36+
## Windows
37+
At this time we have not tested the windows operating system.

0 commit comments

Comments
 (0)