Unverified Commit 970f8beb authored by SirSoliloque's avatar SirSoliloque Committed by GitHub
Browse files

Create README.md

parent 74eb4fc1
Loading
Loading
Loading
Loading

README.md

0 → 100644
+63 −0
Original line number Diff line number Diff line
# POMODORO Timer - JavaScript Project

## Overview

The POMODORO Timer is a simple JavaScript-based timer that allows you to implement the Pomodoro Technique for efficient time management. This timer helps you break your work or study sessions into focused intervals (called "Pomodoros") followed by short breaks. You can customize the timer settings by using the Parameters button and adjust the sliders to suit your preferences.

## Features

- Start, pause, and restart the timer with a single button.
- Customize Pomodoro and break duration using sliders.
- User-friendly interface for easy navigation.

## Getting Started

Follow these steps to get started with the POMODORO Timer:

1. Clone the repository to your local machine.

```bash
git clone https://github.com/your-username/pomodoro-timer.git
```

2. Open the `index.html` file in your web browser to launch the POMODORO Timer.

## How to Use

1. **Launch the Timer**
   - Click the "Play" button to start the timer. This button will turn into a "Stop" button after your first press.

2. **Customize Timer Parameters**
   - Click the "Parameters" button to access the customization options.
   - Use the sliders to adjust the Pomodoro and break duration according to your preferences.

3. **Pause and Resume**
   - If you need to pause the timer, click the "Stop" button.
   - To resume the timer, simply click the "Play" button again.

4. **Repeat Pomodoros**
   - You can repeat the Pomodoro cycle as many times as needed by clicking the "Play" button after each break.

## Technologies Used

- JavaScript
- HTML
- CSS

## Credits

This project was created by Victor FRIBOULET and is open-source under the GNU General Public License (GNU GPL) version 3. Contributions are welcome; feel free to submit pull requests or report issues on the GitHub repository.

## License

This project is licensed under the [GNU General Public License (GNU GPL) version 3](LICENSE.md). See the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

- Special thanks to the creators of the Pomodoro Technique for their time management method.

## Support

If you have any questions, suggestions, or encounter any issues, please feel free to contact us at [victorfriboulet07@gmail.com].