X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/1d9261eb093db6618ae886483bdde36d701289de..bdbbf89c38126a71b17049469e8f976c571b9392:/README.md diff --git a/README.md b/README.md index 620807c..0c4575c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ -This is a lua library for time and date manipulation. +# luatz -Importantly, it allows you to convert time between locations (time zones). +A lua library for time and date manipulation. + +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 + + +[![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz) [![Coverage Status](https://coveralls.io/repos/github/daurnimator/luatz/badge.svg?branch=master)](https://coveralls.io/github/daurnimator/luatz?branch=master) + +Supported under Lua 5.1, 5.2, 5.3 and LuaJIT. + + +## Documentation Documentation can be found in the `doc` sub-directory. -[![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz) +An online version can be found at https://daurnimator.github.io/luatz/ ## Installation -### via [luarocks](http://luarocks.org/) +### via [luarocks](https://luarocks.org/modules/daurnimator/luatz) luarocks install luatz - -[MoonRocks link](https://rocks.moonscript.org/modules/daurnimator/luatz) -