Whitespace removal

[etc/awesome.git] / README.md

diff --git a/README.md b/README.md
index 16b9f160bdaf49109431940c75ece29a47be9b0f..0c4575c71cb24cb9c0d265294ccca61c1455c139 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +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.

 
 

-Documentation can be found in the `docs` directory.
+Features include:

 
 

-[![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz)
+  - 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.
+
+An online version can be found at https://daurnimator.github.io/luatz/
+
+
+## Installation
+
+### via [luarocks](https://luarocks.org/modules/daurnimator/luatz)
+
+    luarocks install luatz