From d615961430aca9668cfb056aef6024c4ed41eff8 Mon Sep 17 00:00:00 2001
From: Robert Strack <robert.strack@gmail.com>
Date: Wed, 18 Nov 2015 21:09:18 -0500
Subject: [PATCH] readme file

---
 plugins/timer/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 plugins/timer/README.md

diff --git a/plugins/timer/README.md b/plugins/timer/README.md
new file mode 100644
index 000000000..19072cb24
--- /dev/null
+++ b/plugins/timer/README.md
@@ -0,0 +1,18 @@
+This plugin allows to display command's execution time in a very nonintrusive way.
+
+Timer can be tuned by these two variables:
+* `TIMER_PRECISION` allows to control number of decimal places (default `1`)
+* `TIMER_FORMAT` allows to adjust display format (default `'/%d'`)
+
+Sample session:
+
+    me@here:~$ sleep 1                                         /1.0s
+    me@here:~$ sleep 73                                     /1m13.0s
+    me@here:~$ TIMER_FORMAT='[%d]'; TIMER_PRECISION=2         [0.00s]
+    me@here:~$ head -c50 < /dev/urandom | hexdump
+    0000000 b2 16 20 f0 29 1f 61 2d 8a 29 20 8c 8c 39 5a ab
+    0000010 21 47 0e f9 ee a4 76 46 71 9e 4f 6b a4 c4 51 cb
+    0000020 f9 1f 7e b9 6f 2c ae dd cf 40 6d 64 a8 fb d3 db
+    0000030 09 37
+    0000032                                                  [0.02s]
+