WaterBuddy 💧
Stay Hydrated, Stay Productive!
WaterBuddy is a lightweight and intuitive Visual Studio Code extension designed to help developers maintain healthy hydration habits during long coding sessions. With gentle, customizable reminders, WaterBuddy ensures you never forget to take a water break, boosting your productivity and well-being.
Features
- 💧 Hydration Reminders: Receive friendly, unobtrusive notifications to drink water at regular intervals.
- ⏰ Customizable Intervals: Set your preferred reminder frequency (default: 30 minutes).
- 🔔 Status Bar Integration: A water droplet icon in the status bar indicates the reminder status.
- 💤 Snooze Functionality: Temporarily pause reminders during intense coding sessions.
- 🎯 Easy Toggle: Quickly enable or disable reminders with a single click.
When it’s time for a water break, WaterBuddy displays a notification with options to dismiss, snooze, or mark the reminder as done. The status bar icon updates dynamically to reflect the current state (On, Off, or Snoozing).
Screenshots
Requirements
- Visual Studio Code: Version 1.80.0 or higher.
- No Additional Dependencies: Lightweight and ready to use out of the box.
Extension Settings
WaterBuddy contributes the following configuration option to VS Code:
waterBuddy.intervalInMinutes
:
- Type:
number
- Default:
30
- Range:
1
to 240
minutes
- Description: Set the interval between hydration reminders.
How to Use
- Automatic Start: WaterBuddy automatically activates when you launch VS Code.
- Status Bar Controls:
- Toggle reminders on or off.
- Notification Actions:
- Dismiss: Close the reminder notification.
- Snooze 15min: Pause reminders for 15 minutes.
- Mark as Done: Acknowledge the reminder and continue working.
Known Issues
No known issues at this time. If you encounter any problems, please report them here.
Release Notes
Version 1.1.2
- Improved Reliability: Enhanced error handling and state management.
- Better User Experience: Smoother transitions between reminder states.
- Configuration Validation: Ensures interval settings are within valid ranges.
Version 1.0.0
- Initial Release: Basic hydration reminder functionality with customizable intervals, status bar controls, and snooze support.
Privacy
WaterBuddy respects your privacy. It does not collect, store, or transmit any personal data. All settings are stored locally within your VS Code configuration.
Contributing
We welcome contributions! If you have ideas for new features, improvements, or bug fixes, please:
- Open an issue on our GitHub repository.
- Submit a pull request with your proposed changes.
For more details, check out our contribution guidelines.
License
WaterBuddy is open-source software licensed under the MIT License.
Resources
Happy Coding, and Stay Hydrated! 💧