Merge branch 'main' of https://github.com/Tamzuu/Study-Time-Tracker-Python

Author: simon-milata

README.md

@@ -1,11 +1,63 @@
-# Simple Study Timer Tracker
-Features:
-- Saves data to an excel file
-- Displays graphs
-- Displays history
-  
-![image](https://github.com/Tamzuu/Study-Time-Tracker-Python/assets/10380019/9c4940f4-51a3-4da6-8ed6-e8f3e014d449)
+# Study Time Tracker
 
-![image](https://github.com/Tamzuu/Study-Time-Tracker-Python/assets/10380019/96749fc8-dbd2-49dc-84d8-ae9244162c0e)
+Welcome to Study Time Tracker, an application designed to help you manage your study sessions effectively!
 
-![image](https://github.com/Tamzuu/Study-Time-Tracker-Python/assets/10380019/f7dcfe1a-011f-4088-a591-4e7bdc56d3a7)
+## Features
+
+- **Timer**: Start the timer to begin a study session. Pause and resume as needed.
+- **Subject Selection**: Choose a subject for your study session to keep your study sessions organized.
+- **Data Visualization**: View your study progress over time with insightful charts.
+- **History**: Review past study sessions in the history tab to track your productivity.
+- **Eye Care Setting**: Enable the 20/20/20 setting to take breaks and care for your eyes during long study sessions.
+- **Color Settings**: Customize the app's color theme to suit your preferences.
+
+## Installation
+
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/Tamzuu/Study-Time-Tracker-Python.git
+    ```
+
+2. Navigate to the project directory:
+    ```bash
+    cd Study-Time-Tracker-Python
+    ```
+
+3. Install dependencies:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+## Usage
+
+1. Run the application:
+    ```bash
+    python study_time_tracker.py
+    ```
+
+2. Start a study session by setting a timer and selecting a subject.
+3. Use the app's features to track your progress and maintain a productive study routine.
+
+## Screenshots
+
+<img src="https://github.com/Tamzuu/Study-Time-Tracker-Python/assets/10380019/ac7da226-35e4-4580-8047-c102ee8c3f2f" width="800">
+
+## Upcoming Features
+
+- **Pomodoro Timer**: Introduce a Pomodoro technique timer to help users study with intervals of focused work and short breaks.
+- **Notes**: Allow users to take notes during their study sessions to jot down important points or ideas.
+- **Achievements**: Implement an achievement system to reward users for meeting study goals and maintaining consistent study habits.
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature/improvement`).
+3. Make your changes and commit them (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature/improvement`).
+5. Create a new Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.