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

Move to consistent whitespace style
[etc/awesome.git] / README.md
index 6a4c5cd7399d237f693f1303b4f96ebeb796969d..0602db9f5bd2ca525404a94f9cbb5044d294050f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,29 @@
-This is a lua library for time and date manipulation.
+# luatz
+
+A lua library for time and date manipulation.
 
 Features include:
 
 Features include:
+
   - Normalisation of broken down date objects
   - 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.
   - Conversion between locations (time zones) using your local [zoneinfo](https://www.iana.org/time-zones) database.
-  - `stftime` formatting
+  - `strftime` style formatting
 
 
 [![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
 
 Documentation can be found in the `doc` sub-directory.
 
 
 Documentation can be found in the `doc` sub-directory.
 
+An online version can be found at https://daurnimator.github.io/luatz/
+
 
 ## Installation
 
 
 ## Installation
 
-### via [luarocks](http://luarocks.org/)
+### via [luarocks](https://luarocks.org/modules/daurnimator/luatz)
 
     luarocks install luatz
 
     luarocks install luatz
-
-[MoonRocks link](https://rocks.moonscript.org/modules/daurnimator/luatz)
-