]> git.madduck.net Git - etc/awesome.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

luatz/init: Add `now()` function
[etc/awesome.git] / README.md
index 700a91b269575cbb8e703aeb3187039cbe77df27..6a4c5cd7399d237f693f1303b4f96ebeb796969d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 This is a lua library for time and date manipulation.
 
-Importantly, it allows you to convert time between locations (time zones).
+Features include:
+  - Normalisation of broken down date objects
+  - Conversion between locations (time zones) using your local [zoneinfo](https://www.iana.org/time-zones) database.
+  - `stftime` formatting
+
+
+[![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz)
+
+
+## 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)
+