remvze / relaxer Goto Github PK

• ⚡ Installation
• ✨ Usage
• 🔮 Commands
• 🤝 Contributing
• ⭐ Support
• 📜 License

To install Relaxer, you need Node.js and npm installed on your machine. You can install the CLI tool globally using the following command:

npm install -g relaxer

After installation, you can run the CLI tool using the following command:

relaxer [command] [options]

To see a list of available commands and options, run:

relaxer --help

Start a breathing exercise.

relaxer exercise [options]

Options:

• --type <type>: The type of the exercise (i.e., box, 4-7-8, pursed-lip, resonant).

Start a custom breathing exercise.

relaxer custom [options]

Options:

• --inhale <seconds>: Custom breath in time in seconds. (Required)
• --hold-inhale <seconds>: Custom hold time after inhaling in seconds.
• --exhale <seconds>: Custom breath out time in seconds. (Required)
• --hold-exhale <seconds>: Custom hold time after exhaling in seconds.

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with a descriptive commit message.
4. Push your changes to your fork.
5. Open a pull request with a detailed description of your changes.

Please make sure to follow our Contributing Guidelines.

If you find this project useful, please consider supporting it by giving it a star on GitHub. Your support helps us continue to improve and maintain the project.

You can also support the project by making a donation. Every little bit helps and is greatly appreciated!

Thank you for your support!

This project is licensed under the MIT License. See the LICENSE file for details.

Thank you for using Relaxer! If you have any questions or feedback, please open an issue on GitHub.