Skip to content

Commit 26eab33

Browse files
committed
Update Readme
1 parent a71e8b7 commit 26eab33

10 files changed

Lines changed: 60 additions & 9 deletions

README.md

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,55 @@ Simple Coding Time Tracker is a powerful extension for Visual Studio Code that h
99

1010
- **Automatic Time Tracking**: Seamlessly tracks your coding time in the background.
1111
- **Project-based Tracking**: Organizes time data by project for easy analysis.
12+
- **Smart Activity Detection**: Automatically pauses tracking during periods of inactivity.
1213
- **Status Bar Display**: Shows your today's total coding time duration in real-time.
13-
- **Tooltip on Status Bar**: Shows the total coding time weekly, monthly, and all time basis.
14-
- **Detailed Summaries**: View comprehensive reports of your coding activity. You can search your total time on a particular day or project.
14+
- **Tooltip on Status Bar**: Shows the total coding time weekly, monthly and all time basis.
15+
- **Interactive Data Visualization**:
16+
- Project Summary Chart: Visual breakdown of time spent on each project
17+
- Daily Activity Timeline: Interactive line chart showing your coding patterns
18+
- Activity Heatmap: 3-month calendar view showing coding intensity
19+
- Theme-Aware Charts: Automatically adapts to VS Code's light/dark themes
20+
- **Advanced Search & Filtering**:
21+
- Date Range Selection: Filter data by specific time periods
22+
- Project Filtering: Focus on specific projects
23+
- Quick Reset: One-click reset for search filters
1524
- **Data Persistence**: Safely stores your time data for long-term analysis.
1625
- **Configurable Settings**:
1726
- Save Interval: Customize how often your coding time data is saved (default: 5 seconds)
1827
- Inactivity Timeout: Set how long to wait before stopping the timer when no activity is detected (default: 5 minutes)
1928

2029
## Screenshots
21-
### Status Bar
30+
### Coding time summary
31+
The summary page provides a detailed report of your coding activity with interactive charts and visualizations:
32+
- Project distribution chart showing time allocation across projects
33+
- Daily activity timeline with interactive tooltips
34+
- 3-month activity heatmap for long-term pattern analysis
35+
- Theme-aware visualizations that adapt to your VS Code theme
36+
- Advanced search and filtering capabilities
37+
38+
![Coding Summary ](./images/coding_summary.png)
39+
40+
#### Dark theme
41+
![Coding Summary Dark Theme](./images/summry_blck.png)
42+
43+
#### Filtering options
44+
![Filter](./images/filter_summry.png)
45+
46+
#### Status Bar
2247
Status bar resets to zero at midnight each day and hence shows the coding time for the current day.
2348
![Status Bar](./images/statusbar.png)
2449

25-
### Tooltip
50+
#### Tooltip
2651
Tooltip shows the total coding time weekly, monthly and all time basis.
2752
![Tooltip](./images/tooltip.png)
2853

29-
### Summary page
30-
The summary page provides a detailed report of your coding activity. You can search your total time on a particular day or project.
54+
#### Automatic Pause/Resume
55+
When the user is inactive for a period of time, the timer automatically pauses and resumes when the user starts typing again coding again.
56+
![Pause/Resume icon](./images/paused_time.png)
57+
58+
It is configurable from the settings. Default value is 5 minutes.
59+
![Settings](./images/settings.png)
3160

32-
![Summary page ](https://raw.githubusercontent.com/twentyTwo/static-file-hosting/main/vsc-ext-coding-time-tracker-files/Simple-Coding-Time-Tracker.gif)
3361

3462
### All Command Palette Commands
3563
There are total 3 commands in the command palette available for this extension.
@@ -51,7 +79,23 @@ There are total 3 commands in the command palette available for this extension.
5179

5280
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.
5381

54-
To access detailed summaries and reports, use the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and search for "SCTT" to see available commands.
82+
## Feature Details
83+
84+
1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS)
85+
2. Search for "SCTT: Show Coding Time Summary"
86+
3. Explore your coding statistics through interactive visualizations:
87+
- View project distribution in the Project Summary chart
88+
- Track daily patterns in the Activity Timeline
89+
- Analyze long-term trends in the Activity Heatmap
90+
- All charts automatically adapt to your VS Code theme
91+
92+
### Using Search & Filters
93+
94+
1. In the summary view, locate the search form
95+
2. Select a date range using the date pickers
96+
3. Optionally choose a specific project from the dropdown
97+
4. Click "Search" to apply filters
98+
5. Use "Reset" to clear all filters and refresh the view
5599

56100
### Configuration Options
57101

@@ -74,7 +118,7 @@ You can customize the extension's behavior through VS Code settings:
74118
The extension provides the following commands through the Command Palette:
75119

76120
- **Show Summary** (`SCTT: Show Coding Time Summary`):
77-
Displays a comprehensive summary of your coding activity, including total time invested in projects and a daily breakdown.
121+
Displays a comprehensive summary of your coding activity with interactive charts and visualizations.
78122

79123
- **Reset Timer for Today** (`SCTT: Reset Coding Timer for Today`):
80124
Resets the coding time tracker for the current day, allowing you to start anew.
@@ -84,6 +128,13 @@ The extension provides the following commands through the Command Palette:
84128

85129
## Changelog
86130

131+
### [0.2.4] - 2025-04-13
132+
- Added smart activity detection with configurable inactivity timeout
133+
- Enhanced chart interactivity and responsiveness
134+
- Improved theme compatibility for all visualizations
135+
- Added quick reset button for search filters
136+
- Refined chart tooltips and legends for better readability
137+
87138
### [0.2.3] - 2025-03-19
88139
- Made the save interval configurable by the user, with a default of 5 seconds.
89140
- Updated the documentation to reflect the new configuration option.

images/Summarypage_new.png

-41.3 KB
Binary file not shown.

images/coding_summary.png

70.2 KB
Loading

images/filter_summry.png

56.1 KB
Loading

images/new_summarypage.png

-41.3 KB
Binary file not shown.

images/paused_time.png

9.14 KB
Loading

images/settings.png

15 KB
Loading

images/statusbar_click.png

23.2 KB
Loading

images/summarypage.png

-62.6 KB
Binary file not shown.

images/summry_blck.png

71.1 KB
Loading

0 commit comments

Comments
 (0)