Skip to content

Commit 6715b89

Browse files
committedApr 10, 2024
docs: improve usage instructions, add examples
1 parent aab6c56 commit 6715b89

File tree

1 file changed

+78
-3
lines changed

1 file changed

+78
-3
lines changed
 

‎README.md

+78-3
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,88 @@ nix run github:uncenter/kittysay -- ":3"
6868

6969
## Usage
7070

71+
```sh
72+
kittysay <message>
73+
# or using stdin
74+
echo <message> | kittysay -
75+
```
76+
77+
### `--width`
78+
79+
You can use the `--width` flag to change the width of the speech bubble. Defaults to `45`, maxes out at a little less than the width of your terminal if you try to pass a very large number.
80+
81+
```
82+
$ kittysay "meow mrrrow mrrrp nyaaa nya nyaaa meow meowwww nyaaa meowwww"
83+
84+
--------------------------------------
85+
/ meow mrrrow mrrrp nyaaa nya nyaaa meow \
86+
\ meowwww nyaaa meowwww /
87+
--------------------------------------
88+
\
89+
\
90+
/l、
91+
(゚、 。 7
92+
l ~ヽ
93+
じしf_,)ノ
94+
```
95+
96+
```
97+
$ kittysay "meow mrrrow mrrrp nyaaa nya nyaaa meow meowwww nyaaa meowwww" --width 1000
98+
99+
------------------------------------------------------------
100+
< meow mrrrow mrrrp nyaaa nya nyaaa meow meowwww nyaaa meowwww >
101+
------------------------------------------------------------
102+
\
103+
\
104+
/l、
105+
(゚、 。 7
106+
l ~ヽ
107+
じしf_,)ノ
108+
71109
```
72-
kittysay ":3"
73110

74-
echo ":3" | kittysay -
111+
```
112+
 kittysay "meow mrrrow mrrrp nyaaa nya nyaaa meow meowwww nyaaa meowwww" --width 1
113+
114+
-------
115+
/ meow \
116+
| mrrrow |
117+
| mrrrp |
118+
| nyaaa |
119+
| nya |
120+
| nyaaa |
121+
| meow |
122+
| meowwww |
123+
| nyaaa |
124+
\ meowwww /
125+
-------
126+
\
127+
\
128+
/l、
129+
(゚、 。 7
130+
l ~ヽ
131+
じしf_,)ノ
132+
75133
```
76134

77-
You can use the `--width` flag to change the width of the message box (`kittysay ":3" --width 100`), or the `--think` flag to enable "think" mode (in which the speech bubbles are replaced with thought bubbles, similar to the `cowthink` program).
135+
### `--think`
136+
137+
You can use the `--think` flag to enable "think" mode, where the speech bubbles are replaced with thought bubbles (similar to the `cowthink` program).
138+
139+
```
140+
$ kittysay --think ":3"
141+
142+
⏜⏜
143+
( :3 )
144+
⏝⏝
145+
146+
147+
/l、
148+
(゚、 。 7
149+
l ~ヽ
150+
じしf_,)ノ
151+
152+
```
78153

79154
## License
80155

0 commit comments

Comments
 (0)