X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/2ff8dd097b432817a552f67d4fa527c579371597..fffe7001632c142b534df10152ae0ee6dc55e0d1:/README.md

diff --git a/README.md b/README.md
index 700a91b..ef29ccc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
-This is a lua library for time and date manipulation.
+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.
+  - `stftime` style formatting
+
+
+[![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)
 
-Importantly, it allows you to convert time between locations (time zones).