Update README

This commit is contained in:
Tim Van Baak 2020-07-20 15:58:11 -07:00
parent f56894ccef
commit 4fe914e1a3
1 changed files with 29 additions and 11 deletions

View File

@ -1,21 +1,39 @@
# horsay
Takes a line of input and formats it in a text bubble next to a horse.
```
$ horsay
~$ horsay --help
usage: horsay [-h] [-u] [-w MAX_WIDTH] [-b BREAK_AT]
Displays input straight from the horse's mouth.
optional arguments:
-h, --help show this help message and exit
-u, --unicode Use fancier lines for the text bubble
-w MAX_WIDTH, --max-width MAX_WIDTH
Maximum width of output (default: 80)
-b BREAK_AT, --break-at BREAK_AT
String of characters to break words at (default: space
and -)
~$ horsay
Hello, world!
./|,,/|
< o o)
<\ ( | ──┤ Hello, world! │
<\\ |\ | ╰───────────────╯
< o o) +---------------+
<\ ( | --| Hello, world! |
<\\ |\ | +---------------+
<\\\ |(__)
<\\\\ |
$ echo Hello, world! | horsay
~$ echo "Hello, pipe!" | horsay
./|,,/|
< o o)
<\ ( | ──┤ Hello, world! │
<\\ |\ | ╰───────────────╯
< o o) +--------------+
<\ ( | --| Hello, pipe! |
<\\ |\ | +--------------+
<\\\ |(__)
<\\\\ |
~$ echo "Hello, fancy box!" | horsay -u
./|,,/|
< o o)
<\ ( | ──┤ Hello, fancy box! │
<\\ |\ | ╰───────────────────╯
<\\\ |(__)
<\\\\ |
```