Update README.md with examples

README.md

@@ -1,2 +1,145 @@
 # ascii-art-generator-cli
 Generate an ASCII Art from keyword put in the cli
+
+
+## Install
+
+```bash
+git clone https://github.com/Nathanlauga/ascii-art-generator-cli
+cd ascii-art-generator-cli
+pip install -r requirements.txt
+pip install .
+```
+
+## Usage
+
+
+`ascii-generator --help`
+
+```
+Usage: ascii-generator [OPTIONS] KEYWORD
+
+  Shows differents ASCII Art given a keyword
+
+  You can change the number of columns and the scale. There are 2 gray scale
+  available 10 and 70 (default is 70)
+
+Options:
+  -c, --cols INTEGER         Number of columns for ASCII Art.
+  -s, --scale FLOAT          Height scale for ASCII Art.
+  -m, --more-levels BOOLEAN  Whether you want a grayscale of 70 or 10.
+  --help                     Show this message and exit
+```
+
+### Try without options
+
+```bash
+ascii-generator yoda
+```
+
+Output
+
+```
+Image name : Yoda Costume
+.........................',/nx|[]()fxn)}}1/{>>>Il!+-[]_!`......................
+..........................^\nu/{-}rj1{[[[{)xf<~!<]}[]_<:'......................
+..........................',?{}]-(XnYXntjuYCXc<!~++<i:'........................
+..............................'`^1(}((}<~}{)}j\>"`'............................
+................................'>|)|{(\\)}){|}`'..............................
+.................................'+t/\/rj/tfj|`'...............................
+................................^::uZr///txxrzl,,^'............................
+..........................'.`!~]aa#maLzvucc0q1|[~+~,`'........."'..............
+.........................'^>1\]}ahMohbmbbbhZ-[++++~<<<'.'...'',<`'.''^'........
+.........................,{/|(--kdqbbdwpdaJ?[~_]+(?+~~<;^''.,>}-I:<+_".........
+.......................'`})j\\-~Jqqwddwqkn<_~_[[n||)[]?--~+_nj?_+]f(!'.........
+........................i{(t\r]~fwwqqmmdZ++--[}/0j\()1{[1r|}_nr\|}+}i`.........
+........................[)\f\n(++mwqqwqk{_??[}tx0Jt())111j\\?fr\ff\;'..........
+.......................l{(/jnfj]~YwqqwpC-]][{/rr0Qr|)))({(\t(x\\/[`'.'.........
+.......................[{|/rJtj/}(dqqqmn?}})/rurCUI((()(|ppCUn1i;''............
+......................,{{\jrUUJwoqmO0OO00QLOmpbkk('I())\xcYZq("................
+......................<{(xnnYOqdmzbqqda}}11|tnvnYu^'i()|Xzzzc^'................
+...................'''}{/uUvcZmwwuqqmOw{1)(/jxvxun~''-{tcccu|''................
+....................'~11/vLCuL0LCuqmZOw1)(\fruurrf].'`?)vcnt!''................
+....................,\{1/nUCr{Y\\|bppqb()\trnvuj/|[:'.,xnux('..................
+...................'?({(tuJCf1vf/(hpqqa\|\fnvux/|1[l'..;?}_"...................
+...................`[{{(fuJL/)jf\)qkdqo\//juvnf\){]I'..........................
+...................'>/fxuzLv|)ft/(C*apa///junr/|){[<'..........................
+.................'"[//zxYt"+()//\|x##ba\\\trrf\)1}[?"..........................
+................''_}jr\c}..-))\/\||##hb(\\/tt\(){{[?!..........................
+................"<~ij)/;'''[))(\/\|***q(|(||\()1}{}?~'.........................
+.........................'`|)((/t/\*MWZ)((((|))1}{{]-`.........................
+..........................;|)(|\ft{bM80))())(111{1{[?l.........................
+..........................~()((\t\(OM8b)(())))11}11}?-'........................
+..........................}())((\((U#W#()|))11{{}{)1[?l.'......................
+........................'>()(()|||(x#*UCxuuxncUX/\/)]<"'.......................
+.......................'.}{(\/|/tjjc#J+}pqqZQQha0U\'''.........................
+.........................'l0wdkkkbdkL!'',vqwZQ0wwZQ:'..........................
+Do you want to keep this image ? (y/n)y
+Awesome !
+
+```
+
+# Change number of columns
+```
+ascii-generator yoda --cols 50
+```
+
+Output
+
+```
+Image name : Yoda Costume
+................"jx([(jt}}(\>i!+]]~^..............
+................'~{]-rjct/xXn<>+<l`...............
+...................''([{[][])?^'..................
+....................'l////|rt^....................
+.................."ltuqCxrvYu-i!^.......'.........
+................;?)?Oahdqdbu?++_<>"'..'!I'`,'.....
+...............,1/|+zqqpwd(_+[/|{?-~>~\}_]|;......
+...............-(/f-/wqwqc_?[\Cr(){1t))j/(-"......
+.............."{\nj)-wqwp}][|rCz|))1/\///-'.......
+..............>1tvzczQmZQruzJQZ]+()fZZYi^.........
+.............'}\ncQpqCqqY))/nvY}'])vzz]'..........
+.............i{fJYCO0YmOv)|fnnx\`^[nvj"'..........
+............`1{fYz(c\UpqY(/xux/1I.Ijx-............
+............l{)jUv)x/cbqJ/funf(}l..`^.............
+...........'<tnzt\(f\r*bC\tnj\)}~'................
+..........'i|xx?.}(/\\#aY\\t/({}?^................
+..........";l~;''))|/\*Mc((|(1}{]I................
+................;((|t|b&v(())1{1[~................
+................+))(\(OWJ((111}1{?,...............
+..............'^()((|(zhuUUXYmuj+!`...............
+...............'IQwqpqk]'>Zw0ZwO>'................
+Do you want to keep this image ? (y/n)y
+Awesome !
+```
+
+# Change number of levels
+```
+ascii-generator yoda --cols 42 --more-levels false
+```
+
+Output
+
+```
+Image name : Yoda Costume
+..............-+=-==--==::---:............
+...............:::++==++=::...............
+..................======-.................
+.................-=*+=++-:................
+..............:--#%%###=---::....:........
+.............:==-*####=---=---::=--=:.....
+.............===-=###+--=*+==-=====-......
+............:=++=-###--=+*+===+++-:.......
+............-=+*####*++**#=:==+*=.........
+...........:=+**#*##*==+++=.:=++..........
+...........-=+*=+=##*==++==..-+-..........
+...........-=+*=+=##*=+++=-:..............
+..........-++=-===*%*==+==-:..............
+.........:-=-.:===*%*====---..............
+..............-===+@*====---..............
+..............=====%#====-=-:.............
+.............:=====%=***#*+:..............
+..............+#%%%+.:#####:..............
+Do you want to keep this image ? (y/n)y
+Awesome !
+```