README.md: Add coveralls badge

[etc/awesome.git] / doc / gettime.md

diff --git a/doc/gettime.md b/doc/gettime.md
index 76eddfb6f73ab80c64ad9b98ab14a95eab77ebf2..355057773d48d2b91ed282e3f635faca37cb2dfb 100644 (file)
--- a/doc/gettime.md
+++ b/doc/gettime.md
@@ -1,11 +1,27 @@
-# `luatz.gettime`
+## `luatz.gettime` <!-- --> {#gettime}
 
 A module to get the current time.
 
+Uses the most precise method available (in order:)
 
-## `gettime`
+  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access `clock_gettime(2)` called with `CLOCK_REALTIME`
+  - [lunix](http://25thandclement.com/~william/projects/lunix.html)'s `unix.clock_gettime()` (Only on non-Apple systems)
+  - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access `gettimeofday(2)`
+  - [lunix](http://25thandclement.com/~william/projects/lunix.html)'s `unix.gettimeofday()`
+  - [luasocket](http://w3.impa.br/~diego/software/luasocket/)'s `socket.gettime`
+  - [Openresty](http://openresty.org/)'s [`ngx.now`](http://wiki.nginx.org/HttpLuaModule#ngx.now)
+  - [`os.time`](http://www.lua.org/manual/5.3/manual.html#pdf-os.time)
 
-Uses the most accurate method available (in order:)
+### `source` <!-- --> {#gettime.source}
 
-  - Uses luasocket's `socket.gettime` if available
-  - `os.time`
+The library/function currently in use by [`gettime()`](#gettime.gettime).
+
+
+### `resolution` <!-- --> {#gettime.resolution}
+
+The smallest time resolution (in seconds) available from [`gettime()`](#gettime.gettime).
+
+
+### `gettime()` <!-- --> {#gettime.gettime}
+
+Returns the number of seconds since unix epoch (1970-01-01T00:00:00Z) as a lua number