Merge pull request #7 from twentyTwo/develop

Version 0.3.0 Released

Author: twentyTwo

README.md

@@ -9,26 +9,55 @@ Simple Coding Time Tracker is a powerful extension for Visual Studio Code that h
 
 - **Automatic Time Tracking**: Seamlessly tracks your coding time in the background.
 - **Project-based Tracking**: Organizes time data by project for easy analysis.
+- **Smart Activity Detection**: Automatically pauses tracking during periods of inactivity.
 - **Status Bar Display**: Shows your today's total coding time duration in real-time.
-- **Tooltip on Status Bar**: Shows the total coding time weekly, monthly, and all time basis.
-- **Detailed Summaries**: View comprehensive reports of your coding activity. You can search your total time on a particular day or project.
+- **Tooltip on Status Bar**: Shows the total coding time weekly, monthly and all time basis.
+- **Interactive Data Visualization**:
+  - Project Summary Chart: Visual breakdown of time spent on each project
+  - Daily Activity Timeline: Interactive line chart showing your coding patterns
+  - Activity Heatmap: 3-month calendar view showing coding intensity
+  - Theme-Aware Charts: Automatically adapts to VS Code's light/dark themes
+- **Advanced Search & Filtering**:
+  - Date Range Selection: Filter data by specific time periods
+  - Project Filtering: Focus on specific projects
+  - Quick Reset: One-click reset for search filters
 - **Data Persistence**: Safely stores your time data for long-term analysis.
-- **Configurable Save Interval**: Customize how often your coding time data is saved (default: 5 seconds). Adjust this in VS Code settings to balance between data accuracy and system performance.
-
+- **Configurable Settings**: 
+  - Save Interval: Customize how often your coding time data is saved (default: 5 seconds)
+  - Inactivity Timeout: Set how long to wait before stopping the timer when no activity is detected (default: 5 minutes)
 
 ## Screenshots
-### Status Bar
+### Coding time summary
+The summary page provides a detailed report of your coding activity with interactive charts and visualizations:
+- Project distribution chart showing time allocation across projects
+- Daily activity timeline with interactive tooltips
+- 3-month activity heatmap for long-term pattern analysis
+- Theme-aware visualizations that adapt to your VS Code theme
+- Advanced search and filtering capabilities
+
+![Coding Summary ](./images/coding_summary.png)
+
+#### Dark theme
+![Coding Summary Dark Theme](./images/summry_blck.png)
+
+#### Filtering options
+![Filter](./images/filter_summry.png)
+
+#### Status Bar
 Status bar resets to zero at midnight each day and hence shows the coding time for the current day.
 ![Status Bar](./images/statusbar.png)
 
-### Tooltip
+#### Tooltip
 Tooltip shows the total coding time weekly, monthly and all time basis.
 ![Tooltip](./images/tooltip.png)
 
-### Summary page
-The summary page provides a detailed report of your coding activity. You can search your total time on a particular day or project.
+#### Automatic Pause/Resume
+When the user is inactive for a period of time, the timer automatically pauses and resumes when the user starts typing again coding again.
+![Pause/Resume icon](./images/paused_time.png)
+
+It is configurable from the settings. Default value is 5 minutes.
+![Settings](./images/settings.png)
 
-![Summary page ](https://raw.githubusercontent.com/twentyTwo/static-file-hosting/main/vsc-ext-coding-time-tracker-files/Simple-Coding-Time-Tracker.gif)
 
 ### All Command Palette Commands
 There are total 3 commands in the command palette available for this extension.
@@ -39,7 +68,6 @@ There are total 3 commands in the command palette available for this extension.
 
 ![All Command Palette Commands](./images/commands.png)
 
-
 ## Installation
 
 1. Open Visual Studio Code
@@ -51,40 +79,62 @@ There are total 3 commands in the command palette available for this extension.
 
 Once installed, the extension will automatically start tracking your coding time. You can view your current session time in the status bar at the bottom of the VSCode window.
 
-To access detailed summaries and reports, use the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and search for "Time Tracker" to see available commands.
+## Feature Details
 
-### Configuring Save Interval
-You can customize how often the extension saves your coding time data:
-1. Open VS Code Settings (Ctrl+, or Cmd+, on macOS)
-2. Search for "Simple Coding Time Tracker"
-3. Find the "Save Interval" setting
-4. Enter your preferred interval in seconds (default is 5 seconds)
-   - Lower values (e.g., 5-10 seconds) provide more frequent updates but may impact performance
-   - Higher values (e.g., 30-60 seconds) are more efficient but update less frequently
+1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS)
+2. Search for "SCTT: Show Coding Time Summary"
+3. Explore your coding statistics through interactive visualizations:
+   - View project distribution in the Project Summary chart
+   - Track daily patterns in the Activity Timeline
+   - Analyze long-term trends in the Activity Heatmap
+   - All charts automatically adapt to your VS Code theme
 
-## Control Panel Commands
+### Using Search & Filters
 
-The Simple Coding Time Tracker extension offers a range of commands accessible through the Command Palette, designed to streamline your coding time tracking experience. Here are the primary commands available:
+1. In the summary view, locate the search form
+2. Select a date range using the date pickers
+3. Optionally choose a specific project from the dropdown
+4. Click "Search" to apply filters
+5. Use "Reset" to clear all filters and refresh the view
 
-To access these commands, open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
+### Configuration Options
 
-- **Show Summary**: 
-  - Command Title: `SCTT: Show Coding Time Summary`
-  - This command displays a comprehensive summary of your coding activity, including the total time invested in projects and a daily breakdown.
+You can customize the extension's behavior through VS Code settings:
 
-- **Reset Timer for Today**: 
-  - Command Title: `SCTT: Reset Coding Timer for Today`
-  - This command resets the coding time tracker for the current day, allowing you to start anew without any previous data influencing your current session.
+1. Open VS Code Settings (Ctrl+, or Cmd+, on macOS)
+2. Search for "Simple Coding Time Tracker"
+3. Available settings:
+   - **Save Interval**: How often to save your coding time data (in seconds)
+     - Default: 5 seconds
+     - Lower values provide more frequent updates but may impact performance
+     - Higher values are more efficient but update less frequently
+   - **Inactivity Timeout**: How long to wait before stopping the timer when no activity is detected (in minutes)
+     - Default: 5 minutes
+     - Lower values will stop tracking sooner when you're not actively coding
+     - Higher values will continue tracking for longer during breaks
 
-- **Reset All Timers**: 
-  - Command Title: `SCTT: Reset All Coding Timers`
-  - This command resets all coding time trackers. It includes a confirmation prompt to prevent unintended resets, ensuring you have full control over your data.
+### Available Commands
 
-By using these commands, you can effectively manage your coding sessions and maintain precise records of your work.
+The extension provides the following commands through the Command Palette:
 
+- **Show Summary** (`SCTT: Show Coding Time Summary`): 
+  Displays a comprehensive summary of your coding activity with interactive charts and visualizations.
+
+- **Reset Timer for Today** (`SCTT: Reset Coding Timer for Today`): 
+  Resets the coding time tracker for the current day, allowing you to start anew.
+
+- **Reset All Timers** (`SCTT: Reset All Coding Timers`): 
+  Resets all coding time trackers with a confirmation prompt to prevent unintended resets.
 
 ## Changelog
 
+### [0.3.0] - 2025-04-14
+- Added smart activity detection with configurable inactivity timeout
+- Enhanced chart interactivity and responsiveness
+- Improved theme compatibility for all visualizations
+- Added quick reset button for search filters
+- Refined chart tooltips and legends for better readability
+
 ### [0.2.3] - 2025-03-19
 - Made the save interval configurable by the user, with a default of 5 seconds.
 - Updated the documentation to reflect the new configuration option.