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

rockspec: Remove < 5.3 requirement, add supported environments to README
[etc/awesome.git] / README.md
index 620807c1e915fd70682b76f83613b8fb5a1e1ad1..806c65f383aa3e22a04154a8996fe587514690f6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,20 @@
 This is a lua library for time and date manipulation.
 
 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
 
 
-Documentation can be found in the `doc` sub-directory.
 
 [![Build Status](https://travis-ci.org/daurnimator/luatz.png)](https://travis-ci.org/daurnimator/luatz)
 
 
 [![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
 
 
 ## Installation