X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/70bd14f3931bf280e741b7c8a05d0c0028a239c9..a034bb6ae0748d7adc7a04c6a8e5753c0f13eae4:/README.md diff --git a/README.md b/README.md index 16b9f16..ef29ccc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ -This is a lua library for time and date manipulation. +A lua library for time and date manipulation. -Importantly, it allows you to convert time between locations (time zones). +Features include: + - Normalisation of broken down date objects + - allows for complex time/date manipulation logic e.g. "What day is it in 2 days, 5 hours from now?" + - Conversion between locations (time zones) using your local [zoneinfo](https://www.iana.org/time-zones) database. + - `stftime` style formatting -Documentation can be found in the `docs` directory. [![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz) + +Supported under Lua 5.1, 5.2, 5.3 and LuaJIT. + + +## Usage + +Documentation can be found in the `doc` sub-directory. + + +## Installation + +### via [luarocks](http://luarocks.org/) + + luarocks install luatz + +[MoonRocks link](https://rocks.moonscript.org/modules/daurnimator/luatz) +