luatz/gettime: Check that CLOCK constants exist

[etc/awesome.git] / README.md

diff --git a/README.md b/README.md
index 700a91b269575cbb8e703aeb3187039cbe77df27..0602db9f5bd2ca525404a94f9cbb5044d294050f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +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)
+
+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