d615961430aca9668cfb056aef6024c4ed41eff8

Author
Robert Strack <robert.strack@gmail.com>
Committer
Robert Strack <robert.strack@gmail.com>
Date

Message

readme file

Diff

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