forks/ezic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
aj heller
2012-09-30 22:11:07 -07:00
parent 2374ab1394
commit fe2c490734
1 changed files with 19 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -1,36 +1,24 @@
ezic
====
ezic is an erlang libraary for working with timezones. It compiles the Olson timezone database files into native erlang terms, which makes timezone lookup and zone conversion very fast. See the [tz database](http://www.twinsun.com/tz/tz-link.htm) page for more information about the Olson database.
ezic is a native erlang library for working with timezones. It parses the Olson timezone database files, allowing native erlang timezone lookup and zone conversions without the use of shell commands or a UNIX system.
See the [tz database](http://www.twinsun.com/tz/tz-link.htm) page for more information about the Olson database.
Status
------
2010.11.14
* The Zone/Rule flattening algorithm works correctly for a handful of tested zones. `ezic:local_to_utc/2` throws `ambiguous_zone` and `no_zone` errors where appropriate. Aside from bugs and edge cases that are sure to exist, and leap seconds, ezic is mostly functional.
2010.11.07
* The time comparisons don't consider time relativity, so they're plain wrong. Within at least 24 hours of timechange or zone change, the results cannot be trusted.
2010.11.04
* ezic is "apparently functional". It has been tested very lightly, a bit by unit tests, but mostly by inspection. It's probably not fit for production use.
License
Purpose
-------
I have dedicated this work to the [public domain](http://en.wikipedia.org/wiki/Public_Domain). Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
Erlang/OTP didn't have a native timezone library, so I wrote ezic to fill that void.
The [recommended way](http://www.erlang.org/pipermail/erlang-questions/2006-December/024291.html) of handling timezones in erlang involves setting the system environment variable `TZ` to the desired timezone, then calling erlang time functions. As far as I can tell, this technique has a few key issues:
* it only works on *nix systems,
* it depends on your system's timezone data (preventing custom timezone hackery), and
* you can create race conditions if you aren't careful about it
Contributed Code
----------------
To maintain ezic's status as a public domain work, all contributions must also be dedicated to the public domain.
ezic doesn't have these problems. ezic is, however, a young project with who-knows-how-many problems of its own.
@@ -51,7 +39,7 @@ Admin API
Setup
Example Setup
-----
# download the timezone data files
@@ -69,25 +57,23 @@ Setup
Purpose
License
-------
Erlang/OTP didn't have a timezone library, so I wrote ezic to fill that void.
This project is in the [public domain](http://en.wikipedia.org/wiki/Public_Domain). Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
The [recommended way](http://www.erlang.org/pipermail/erlang-questions/2006-December/024291.html) of handling timezones in erlang involves setting the system environment variable `TZ` to the desired timezone, then calling erlang time functions. As far as I can tell, this technique has a few key issues:
* it only works on *nix systems,
* it depends on your system's timezone data (preventing custom timezone hackery), and
* you can create race conditions if you aren't careful
ezic doesn't have these problems. ezic is, however, a young project with who-knows-how-many problems of its own ;)
Contributed Code
----------------
To maintain ezic's status as a public domain work, all contributions must also be dedicated to the public domain.
Acknowledgements
----------------
I was inspired by the (anti-) license of the [SQLite project](http://www.sqlite.org/copyright.html) in my decision to release this into the public domain.
The decision to release this into the public domain was inspired by the (anti-) license of the [SQLite project](http://www.sqlite.org/copyright.html).