Skip to content

Commit b582aba

Browse files
committed
readme updated
1 parent 559e67e commit b582aba

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
1-
# fancy-progress-cli
21

3-
A stylish, emoji-themed CLI progress bar.
2+
# 🎉 fancy-progress-cli
43

5-
## Install
4+
A customizable, emoji-themed CLI progress bar tool for Node.js.
5+
6+
## 📦 Installation
67

78
```bash
89
npm install -g fancy-progress-cli
10+
````
11+
12+
## 🚀 Usage
13+
14+
```bash
15+
fancy-progress --total 50 --speed 80 --theme hearts --message "All done!"
16+
```
17+
18+
## 🔧 Options
19+
20+
| Flag | Alias | Description | Default |
21+
| ----------- | ----- | ---------------------------- | ------------- |
22+
| `--total` | `-t` | Total steps to complete | `50` |
23+
| `--speed` | `-s` | Milliseconds between steps | `100` |
24+
| `--theme` | `-m` | Theme for the progress bar | `classic` |
25+
| `--message` | | Final message after complete | `✅ Complete!` |
26+
27+
## 🎨 Themes
28+
29+
* `classic` → █ / ░
30+
* `stars` → ★ / ☆
31+
* `hearts` → ❤ / ♡
32+
* `dots` → ● / ○
33+
* `blocks` → ▓ / ▒
34+
35+
## 💻 Example
36+
37+
```bash
38+
fancy-progress -t 40 -s 60 -m stars --message "✨ Finished!"
39+
```

0 commit comments

Comments
 (0)