Skip to content

VS-Code extension that reminds me to take a 10-minute break after every hour of coding.

License

Notifications You must be signed in to change notification settings

chukusuccess/Coding-Break-Extension

Repository files navigation

Break Reminder for VS Code

Take care of your health while coding! This Break Reminder extension for Visual Studio Code gently nudges you to take a 10-minute break every hour of coding. Stay productive and mindful of your well-being with timely reminders.

How to Use

  1. Install the extension.
  2. hit ctrl + shift + p and type "Remind me to take a break" then hit Enter.
  3. The extension will automatically start reminding you to take a break every hour.

Demo GIF

Features

  • Timely Reminders: Automatically prompts you to take a 10-minute break every hour with a friendly notification.
  • Customizable: Configure your reminder intervals and break durations to suit your work style (coming soon).
  • Snooze or Dismiss: Easily dismiss the current reminder or snooze it for a later time.
  • Stop Reminders: Have the flexibility to stop all subsequent reminders with a single command.

Commands

This extension contributes the following commands:

  • break-reminder.remindBreak: Triggers a break reminder immediately.
  • break-reminder.dismissMessage: Dismisses the current break reminder message.
  • break-reminder.stopReminders: Stops all subsequent break reminders.
  • break-reminder.configure: Opens settings to configure break reminder intervals and durations (feature coming soon).

Installation

Search for "Break Reminder" in the VS Code Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS) and click Install.

Alternatively, you can launch VS Code Quick Open (Ctrl+P or Cmd+P), paste the following command, and press enter:

ext install ChukuSuccess.break-reminder

Contributing & Feedback

Contributions are always welcome! Whether it's submitting bugs, feature requests, or giving feedback, your input helps make this extension better for everyone. Email me at ciferr04@gmail.com if you have any requests, suggestions, or feedback!

License

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

Acknowledgments

  • Thank you to all the users and collaborators who make this project possible.
  • Special thanks to the Visual Studio Code team for their excellent editor and documentation.

Support

If you find this extension useful, please consider rating it on the VS Code Marketplace and sharing it with your friends and colleagues.

For any questions or suggestions, you can also open an issue on the GitHub repository.

About

VS-Code extension that reminds me to take a 10-minute break after every hour of coding.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published