X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/1d9261eb093db6618ae886483bdde36d701289de..03669534f23474ac441b86ce2190e51fdd389b2d:/README.md diff --git a/README.md b/README.md index 620807c..4b1a441 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ -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. + - `strftime` style formatting -Documentation can be found in the `doc` sub-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. -## Installation -### via [luarocks](http://luarocks.org/) +## Usage - luarocks install luatz +Documentation can be found in the `doc` sub-directory. -[MoonRocks link](https://rocks.moonscript.org/modules/daurnimator/luatz) +## Installation + +### via [luarocks](https://luarocks.org/modules/daurnimator/luatz) + + luarocks install luatz