@meebs/meeb 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +131 -91
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,19 +1,29 @@
1
- # meeb
1
+ <div align="center">
2
2
 
3
3
  ```
4
4
  ▐▛███▜▌
5
- ▐█▄███▄█▌ 72 hand-drawn ASCII animals
6
- ▐███▄███▌ for your terminal.
5
+ ▐█▄███▄█▌
6
+ ▐███▄███▌
7
7
  ▝▀███▀▘
8
- ▗▄▛███▜▄▖ zero dependencies.
9
- ▐███████▌ pure joy.
8
+ ▗▄▛███▜▄▖
9
+ ▐███████▌
10
10
  ▐███████▌
11
11
  ▝█████▘
12
12
  ▟█▙ ▟█▙
13
13
  ▀▀▀ ▀▀▀
14
14
  ```
15
15
 
16
- A passion project to bring a little good into the world. Because every terminal deserves a friend.
16
+ **72 hand-drawn ASCII animals for your terminal.**
17
+
18
+ zero dependencies. pure joy.
19
+
20
+ [![npm](https://img.shields.io/npm/v/@meebs/meeb?color=d7775b&label=npm)](https://www.npmjs.com/package/@meebs/meeb)
21
+ [![license](https://img.shields.io/badge/license-CC%20BY--NC%204.0-blue)](https://creativecommons.org/licenses/by-nc/4.0/)
22
+ [![node](https://img.shields.io/badge/node-%3E%3D14-green)](https://nodejs.org)
23
+
24
+ </div>
25
+
26
+ ---
17
27
 
18
28
  ## Install
19
29
 
@@ -21,7 +31,7 @@ A passion project to bring a little good into the world. Because every terminal
21
31
  npm install -g @meebs/meeb
22
32
  ```
23
33
 
24
- ## Quick Start
34
+ ## Try It
25
35
 
26
36
  ```bash
27
37
  meeb fox # show a fox
@@ -30,129 +40,159 @@ meeb cat hat # seasonal hat (changes every month!)
30
40
  meeb random # surprise me
31
41
  meeb 🐧 # emoji lookup
32
42
  echo "hello" | meeb dog # pipe stdin as speech
33
- meeb --motd # add to your .bashrc for daily joy
34
43
  ```
35
44
 
36
- ## Animals
45
+ ## 72 Animals
37
46
 
38
47
  ```
39
- ▄▖ ▗▄ ▄██▖ ▗██▄
40
- ██▖ ▗██ ████▖ ▗████
41
- ▐██▄▄▄██▌ ▝███████████▘
42
- ▐█◆█▄█◆█▌ ▐█●███●█▌ ...and 70 more
43
- ▐███▄███▌ ▐██▄▄▄██▌
44
- ▝▀███▀▘ ▐██▀▀▀██▌
45
- ▐█████▌ ▐███████▌
46
- ▐███████▌ ▟█▘ ▝█▙
47
- ▟▘ ▝▙ ▀▀▀ ▀▀▀
48
- fox dog
48
+ ▄▖ ▗▄ ● ● ▄██▖ ▗██▄
49
+ ██▖ ▗██ ▐█▌ ▐█▌ ████▖ ▗████
50
+ ▐██▄▄▄██▌ ▝█▘ ▝███████████▘
51
+ ▐█◆█▄█◆█▌ ▐████▌ ▐█●███●█▌
52
+ ▐███▄███▌ ▐██████▌ ▐██▄▄▄██▌
53
+ ▝▀███▀▘ ▐████████▌ ▐██▀▀▀██▌
54
+ ▐█████▌ ▐████████▌ ▐███████▌
55
+ ▐███████▌ ▝▀▀▀▀▘ ▟█▘ ▝█▙
56
+ ▟▘ ▝▙ ▀▀▀ ▀▀▀
57
+ fox snail dog
58
+ ```
59
+
60
+ <details>
61
+ <summary><strong>See all 72 →</strong></summary>
62
+ <br>
63
+
64
+ penguin · cat · dog · fox · bear · owl · bunny · frog · panda · snake · duck · mouse · whale · octopus · bat · fish · turtle · crab · monkey · pig · koala · lion · shark · elephant · unicorn · jellyfish · sloth · wolf · parrot · hedgehog · giraffe · flamingo · raccoon · hippo · deer · squid · gorilla · dragon · alien · robot · ghost · dino · zebra · snail · bee · butterfly · scorpion · emperor · crocodile · chameleon · seahorse · stingray · axolotl · capybara · redpanda · peacock · spider · chick · ladybug · otter · mantisshrimp · narwhal · moth · cookie · hamster · swan · eagle · walrus · toucan · yak · firefly · starfish
65
+
66
+ </details>
67
+
68
+ ## Animations
69
+
70
+ Four built-in terminal animations:
71
+
72
+ ```bash
73
+ meeb penguin delay # ✨ pixels materialize from nothing
74
+ meeb penguin slide # → slides in from the right
75
+ meeb fox fall # ↓ drops from the top with a bounce
76
+ meeb snail shatter # 💥 appears, then explodes with gravity
49
77
  ```
50
78
 
51
- penguin, cat, dog, fox, bear, owl, bunny, frog, panda, snake, duck, mouse, whale, octopus, bat, fish, turtle, crab, monkey, pig, koala, lion, shark, elephant, unicorn, jellyfish, sloth, wolf, parrot, hedgehog, giraffe, flamingo, raccoon, hippo, deer, squid, gorilla, dragon, alien, robot, ghost, dino, zebra, snail, bee, butterfly, scorpion, emperor, crocodile, chameleon, seahorse, stingray, axolotl, capybara, redpanda, peacock, spider, chick, ladybug, otter, mantisshrimp, narwhal, moth, cookie, hamster, swan, eagle, walrus, toucan, yak, firefly, starfish
79
+ **shatter** draws your animal, holds for a beat, then every character gets launched with random velocity and falls with physics:
80
+
81
+ ```
82
+ step 1: appear step 2: hold... step 3: 💥
83
+
84
+ ● ● ● ● ●
85
+ ▐█▌ ▐█▌ ▐█▌ ▐█▌ ▐ █
86
+ ▝█▘ ▝█▘ █▘ ▌
87
+ ▐████▌ ▐████▌ ▐██
88
+ ▐██████▌ ▐██████▌ █▌ ▌
89
+ ▐████████▌ ▐████████▌ ▐ ██ ███
90
+ ▐████████▌ ▐████████▌ ████ █▌
91
+ ▝▀▀▀▀▘ ▝▀▀▀▀▘ ▀ ▀ ▀▀ ▘
92
+ ```
52
93
 
53
94
  ## Say Things
54
95
 
55
96
  ```
56
- __________
57
- < rawr >
58
- ‾‾‾‾‾‾‾‾‾‾
59
- |
97
+ ______________
98
+ < hello world >
99
+ ‾‾‾‾‾‾‾‾‾‾‾‾‾‾
100
+ |
60
101
 
61
- ▄▖ ▗▄
62
- ██▖ ▗██
63
- ▐█████████████▌
64
- ▝█◆█████████◆█▘
65
- ▐████▀▄▀████▌
66
- ▝▀█████████▀▘
67
- ▄████████████████▄
68
- ▝████▌██████▐████▘
69
- ▟██▘ ▝██▙
70
- ▀▀▀▀ ▀▀▀▀
102
+ ▐▛███▜▌
103
+ ▐█▄███▄█▌
104
+ ▐███▄███▌
105
+ ▝▀███▀▘
106
+ ▗▄▛███▜▄▖
107
+ ▐███████▌
108
+ ▐███████▌
109
+ ▝█████▘
110
+ ▟█▙ ▟█▙
111
+ ▀▀▀ ▀▀▀
71
112
  ```
72
113
 
73
114
  ```bash
74
- meeb dragon say "rawr"
75
- meeb owl fortune # random fortune cookie
76
- meeb penguin commit # git commit message as speech
77
- echo "deploy complete" | meeb cat
115
+ meeb dragon say "rawr" # speech bubble
116
+ meeb owl fortune # random fortune cookie
117
+ meeb penguin commit # git commit message
118
+ echo "deploy complete" | meeb cat # pipe anything
78
119
  ```
79
120
 
80
121
  ## Seasonal Hats
81
122
 
82
- `meeb fox hat` gives your animal a hat that changes every month:
123
+ `meeb fox hat` a different hat every month:
124
+
125
+ | | | | |
126
+ |---|---|---|---|
127
+ | 🎅 **Dec/Jan** Santa | ❤️ **Feb** Heart | ☘️ **Mar** Shamrock | 🌧️ **Apr** Rain |
128
+ | 🌸 **May** Flower | ☀️ **Jun** Sun | 🎆 **Jul** Firework | 😎 **Aug** Shades |
129
+ | 🍂 **Sep** Leaf | 🎃 **Oct** Pumpkin | 🦃 **Nov** Pilgrim | | |
83
130
 
84
- | Month | Hat |
85
- |-------|-----|
86
- | Jan/Dec | Santa hat |
87
- | Feb | Heart |
88
- | Mar | Shamrock |
89
- | Apr | Rain cloud |
90
- | May | Flower |
91
- | Jun | Sun |
92
- | Jul | Firework |
93
- | Aug | Sunglasses |
94
- | Sep | Falling leaf |
95
- | Oct | Jack-o-lantern |
96
- | Nov | Pilgrim hat |
131
+ ## Transforms
97
132
 
98
- ## Features
133
+ ```bash
134
+ meeb fox stretch # wider
135
+ meeb fox squish # narrower
136
+ meeb fox stretchv # taller
137
+ meeb fox squishv # shorter
138
+ meeb fox flip # mirror horizontally
139
+ ```
140
+
141
+ ## Export
99
142
 
100
143
  ```bash
101
- # display
102
- meeb cat tiny # compact 4-row version
103
- meeb fox flip # mirror horizontally
104
- meeb panda --theme neon # color themes: neon, pastel, retro, mono, matrix
105
- meeb bear --no-color # strip ANSI codes
106
- meeb owl --label "wise bird" # subtitle text below the animal
107
-
108
- # transforms
109
- meeb fox stretch # stretch horizontally (wider)
110
- meeb fox squish # squish horizontally (narrower)
111
- meeb fox stretchv # stretch vertically (taller)
112
- meeb fox squishv # squish vertically (shorter)
113
-
114
- # animations
115
- meeb penguin delay # pixels materialize randomly
116
- meeb penguin slide # slide in from the right
117
- meeb fox fall # drop from the top with a bounce
118
- meeb snail shatter # appear, then explode with gravity
144
+ meeb fox --png # save as png
145
+ meeb fox --gif # save as gif
146
+ meeb fox --svg # save as svg
147
+ meeb fox --png --white # white background
148
+ meeb fox --label "best fox" # subtitle text below
149
+ ```
150
+
151
+ ## More
119
152
 
153
+ ```bash
120
154
  # friends
121
155
  meeb cat pair dog # two animals side by side
122
- meeb cat diff fox # compare two animals
156
+ meeb cat diff fox # compare them
123
157
  meeb owl animate # blinking animation
124
158
 
125
- # facts
126
- meeb narwhal info # fun animal fact
127
- meeb calendar # animal of the day
128
-
129
- # browse
159
+ # explore
130
160
  meeb all # show every animal
131
161
  meeb browse # interactive TUI
132
- meeb list # names only (for scripting)
133
-
134
- # export
135
- meeb fox --gif # save as gif
136
- meeb fox --png # save as png
137
- meeb fox --svg # save as svg
138
- meeb fox --png --white # white background export
162
+ meeb narwhal info # fun animal fact
163
+ meeb calendar # animal of the day
139
164
 
140
165
  # devtools
141
- meeb --motd # message of the day for .bashrc/.zshrc
166
+ meeb --motd # daily animal in your shell
142
167
  meeb --commit # git post-commit hook
143
- meeb --ci # markdown-safe output (no ANSI)
168
+ meeb --ci # markdown-safe (no ANSI)
169
+
170
+ # themes
171
+ meeb panda --theme neon # neon, pastel, retro, mono, matrix
172
+
173
+ # completions
174
+ meeb --install-completions # bash, zsh, fish
144
175
  ```
145
176
 
146
- ## Shell Completions
177
+ ## Add to Your Shell
147
178
 
148
179
  ```bash
149
- meeb --install-completions # bash, zsh, and fish
180
+ # ~/.bashrc or ~/.zshrc
181
+ eval "$(meeb --motd)"
150
182
  ```
151
183
 
184
+ Every time you open a terminal, a random animal greets you with a fortune.
185
+
152
186
  ## Zero Dependencies
153
187
 
154
- No `node_modules`. No bloat. Just Node.js 14+ and 72 animals.
188
+ No `node_modules`. No bloat. Just Node.js and 72 animals in 39kb.
189
+
190
+ ---
191
+
192
+ <div align="center">
193
+
194
+ a passion project to bring a little good into the world.
155
195
 
156
- ## License
196
+ [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) — free to use and share, not for commercial use.
157
197
 
158
- [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) — free to use and share with attribution, not for commercial use.
198
+ </div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meebs/meeb",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Cute ASCII art animals for your terminal",
5
5
  "bin": {
6
6
  "meeb": "./index.js"