]> 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:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
README: Update luarocks link
[etc/awesome.git] / README.md
diff --git a/README.md b/README.md
index 16b9f160bdaf49109431940c75ece29a47be9b0f..4b1a4418b6c165658de4b1f7e08a4823bac65d9a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,24 @@
-This is a lua library for time and date manipulation.
+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
+           - 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
 
-Documentation can be found in the `docs` directory.
 
 [![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](https://luarocks.org/modules/daurnimator/luatz)
+
+    luarocks install luatz
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.