X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/e3d5c044607a407cc2ec0975f233879c71c50f94..b810c29ea3652ed987ae54eb56baa79bf24311af:/README.md

diff --git a/README.md b/README.md
index 88fbae2..0602db9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,29 @@
-This is a lua library for time and date manipulation.
+# luatz
+
+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
 
-Importantly, it allows you to convert time between locations (time zones).
 
 [![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.
+
+
+## Documentation
+
+Documentation can be found in the `doc` sub-directory.
+
+An online version can be found at https://daurnimator.github.io/luatz/
+
+
+## Installation
+
+### via [luarocks](https://luarocks.org/modules/daurnimator/luatz)
+
+    luarocks install luatz