2020-04-03 01:11:17 (UTC-03:00)

Marcel Rodrigues <marcelgmr@gmail.com>

add temporary README from manual

diff --git a/README b/README
new file mode 100644
index 0000000..b849fa6
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+MPB(1)                      General Commands Manual                     MPB(1)
+
+
+
+NNAAMMEE
+       mpb - more progress bar
+
+SSYYNNOOPPSSIISS
+       mmppbb [--vv] [--ss] [--ww_W_I_D_T_H] [_T_O_T_A_L]
+
+DDEESSCCRRIIPPTTIIOONN
+       Show progress of lines read from _s_t_d_i_n.
+
+OOPPTTIIOONNSS
+       --vv     show current line
+
+       --ss     show activity spinner
+
+       --ww_W_I_D_T_H
+              set width of progress bar (default = 32)
+
+       _T_O_T_A_L  number of lines expected to be read until completion of task
+              if _T_O_T_A_L is not given or it's zero, the progress bar will not be
+              shown
+
+EEXXAAMMPPLLEESS
+       Use sseeqq((11)) to test drive mmppbb:
+                  $ n=5000; seq 1 $n | mpb -vsw50 $n
+
+       Show progress of ttaarr((11)) extraction:
+                  $ f=foo.tgz; n=$(tar tf $f | wc -l); tar vxf $f | mpb -v $n
+
+
+
+                                  2020-04-02                            MPB(1)