|
| 1 | +To create a `README.md` file for your `fancy-progress-cli` project, I'll help refine the provided content into a polished, professional, and Markdown-formatted README. The content you shared is already well-structured, so I'll enhance it with clearer sections, improved formatting, and additional details commonly found in a README to make it more complete and user-friendly. |
1 | 2 |
|
2 | | -# 🎉 fancy-progress-cli |
| 3 | +Below is the `README.md` content: |
3 | 4 |
|
4 | | -A customizable, emoji-themed CLI progress bar tool for Node.js. |
| 5 | +```markdown |
| 6 | +# 🎉 Fancy Progress CLI |
| 7 | + |
| 8 | +A customizable, emoji-themed CLI progress bar tool for Node.js. Add some flair to your terminal with visually engaging progress bars, perfect for scripts, automation tasks, or just for fun! |
5 | 9 |
|
6 | 10 | ## 📦 Installation |
7 | 11 |
|
| 12 | +Install the package globally using npm: |
| 13 | + |
8 | 14 | ```bash |
9 | 15 | npm install -g fancy-progress-cli |
10 | | -```` |
| 16 | +``` |
11 | 17 |
|
12 | 18 | ## 🚀 Usage |
13 | 19 |
|
| 20 | +Run the CLI with customizable options to display a progress bar with your preferred theme and settings: |
| 21 | + |
14 | 22 | ```bash |
15 | 23 | fancy-progress --total 50 --speed 80 --theme hearts --message "All done!" |
16 | 24 | ``` |
17 | 25 |
|
| 26 | +This command creates a progress bar with 50 steps, updates every 80ms, uses the `hearts` theme, and displays "All done!" when complete. |
| 27 | + |
18 | 28 | ## 🔧 Options |
19 | 29 |
|
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!` | |
| 30 | +Customize the progress bar using the following command-line flags: |
| 31 | + |
| 32 | +| Flag | Alias | Description | Default | |
| 33 | +|-----------------|-------|------------------------------------------|--------------------| |
| 34 | +| `--total` | `-t` | Total number of steps in the progress bar | `50` | |
| 35 | +| `--speed` | `-s` | Interval between updates (milliseconds) | `100` | |
| 36 | +| `--theme` | `-m` | Theme for the progress bar (or `random`) | `classic` | |
| 37 | +| `--message` | `-msg`| Final message after completion | `✅ All done!` | |
| 38 | +| `--list-themes` | | List all available themes with previews | | |
| 39 | + |
| 40 | +Use `--help` or `-h` to see the help menu: |
| 41 | + |
| 42 | +```bash |
| 43 | +fancy-progress --help |
| 44 | +``` |
26 | 45 |
|
27 | 46 | ## 🎨 Themes |
28 | 47 |
|
29 | | -* `classic` → █ / ░ |
30 | | -* `stars` → ★ / ☆ |
31 | | -* `hearts` → ❤ / ♡ |
32 | | -* `dots` → ● / ○ |
33 | | -* `blocks` → ▓ / ▒ |
| 48 | +Choose from a variety of themes to style your progress bar. Use the `--theme` flag to select one, or use `random` for a surprise! |
| 49 | + |
| 50 | +| Theme | Complete / Incomplete | |
| 51 | +|------------|----------------------| |
| 52 | +| `classic` | █ / ░ | |
| 53 | +| `stars` | ★ / ☆ | |
| 54 | +| `hearts` | ❤ / ♡ | |
| 55 | +| `dots` | ● / ○ | |
| 56 | +| `blocks` | ▓ / ▒ | |
| 57 | +| `arrows` | ➤ / ➞ | |
| 58 | +| `flames` | 🔥 / · | |
| 59 | +| `bouncy` | ⣿ / ⣀ | |
| 60 | +| `emoji` | 🟩 / ⬜ | |
| 61 | +| `tech` | # / - | |
| 62 | +| `zen` | ✦ / ⋆ | |
| 63 | +| `sushi` | 🍣 / 🥢 | |
| 64 | +| `moon` | 🌕 / 🌑 | |
| 65 | +| `plants` | 🌱 / 🌿 | |
34 | 66 |
|
35 | | -## 💻 Example |
| 67 | +Preview all themes with: |
36 | 68 |
|
37 | 69 | ```bash |
38 | | -fancy-progress -t 40 -s 60 -m stars --message "✨ Finished!" |
| 70 | +fancy-progress --list-themes |
| 71 | +``` |
| 72 | + |
| 73 | +## 💻 Examples |
| 74 | + |
| 75 | +1. Use the `stars` theme with a custom message: |
| 76 | + |
| 77 | +```bash |
| 78 | +fancy-progress --total 40 --speed 60 --theme stars --message "✨ Finished!" |
| 79 | +``` |
| 80 | + |
| 81 | +2. Try a random theme with 30 steps: |
| 82 | + |
| 83 | +```bash |
| 84 | +fancy-progress --total 30 --theme random --message "Surprise complete!" |
| 85 | +``` |
| 86 | + |
| 87 | +3. Fast progress with the `flames` theme: |
| 88 | + |
| 89 | +```bash |
| 90 | +fancy-progress --total 30 --speed 50 --theme flames --message "🔥 Burn complete!" |
| 91 | +``` |
| 92 | + |
| 93 | +## 🛠️ Dependencies |
| 94 | + |
| 95 | +- [cli-progress](https://www.npmjs.com/package/cli-progress): For rendering the progress bar. |
| 96 | +- [chalk](https://www.npmjs.com/package/chalk): For colorful terminal output. |
| 97 | +- [yargs](https://www.npmjs.com/package/yargs): For parsing command-line arguments. |
| 98 | + |
| 99 | +## 📄 License |
| 100 | + |
| 101 | +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
| 102 | + |
| 103 | +## 🤝 Contributing |
| 104 | + |
| 105 | +Contributions are welcome! Feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/sameer52718/fancy-progress-cli). |
| 106 | + |
| 107 | +## 📬 Contact |
| 108 | + |
| 109 | +For questions or feedback, reach out via [GitHub Issues](https://github.com/sameer52718/fancy-progress-cli/issues). |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +Happy progressing! 🚀 |
39 | 114 | ``` |
0 commit comments