Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ringsaturn committed Jul 24, 2023
1 parent 7a3c1c7 commit 02dc7c4
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# WIP: tzf's Rust port. [![Rust](https://github.com/ringsaturn/tzf-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/ringsaturn/tzf-rs/actions/workflows/rust.yml) [![Documentation](https://docs.rs/tzf-rs/badge.svg)](https://docs.rs/tzf-rs) [![codecov](https://codecov.io/gh/ringsaturn/tzf-rs/branch/main/graph/badge.svg?token=NQFIP9DD86)](https://codecov.io/gh/ringsaturn/tzf-rs)

- Documents: <https://docs.rs/tzf-rs>
- Original Go repo: <https://github.com/ringsaturn/tzf>
- Binary timezone data: <https://github.com/ringsaturn/tzf-rel>
- Geometry: use <https://github.com/ringsaturn/geometry-rs> which is
<https://github.com/tidwall/geometry>'s Rust port.
Package tzf-rs, like original
[Go package tzf](https://github.com/ringsaturn/tzf), is designed for high
performance geo queries and services such as weather forecast APIs.

## Build options

Expand Down Expand Up @@ -47,6 +45,24 @@ good example.
A Redis protocol demo could be used here:
[redizone](https://github.com/ringsaturn/redizone).

## Performance

Below is a benchmark run on global cities(about 14K), and avg time is 3900 ns
per query:

```
test benches_default::bench_default_finder_random_city ... bench: 3,957 ns/iter (+/- 297)
```

You can view latest benchmark from
[GitHub Actions logs](https://github.com/ringsaturn/tzf-rs/actions/workflows/rust.yml).

## References

- Binary timezone data: <https://github.com/ringsaturn/tzf-rel>
- Geometry: use <https://github.com/ringsaturn/geometry-rs> which is
<https://github.com/tidwall/geometry>'s Rust port.

## Bindings

- Ruby, see [tzf-rb](https://github.com/HarlemSquirrel/tzf-rb)
Expand Down

0 comments on commit 02dc7c4

Please sign in to comment.