diff --git a/CHANGELOG.md b/CHANGELOG.md index 91f5704..396cdf8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ ## [Unreleased] +## [1.5.2] - 2025-12-31 + +- Update README + ## [1.5.1] - 2025-12-27 - Fix showing multiple goal notifications per each opened project @@ -94,7 +98,9 @@ - Support IntelliJ Platform 2024.3.5 -[Unreleased]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.5.0...HEAD +[Unreleased]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.5.2...HEAD +[1.5.2]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.5.1...v1.5.2 +[1.5.1]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.5.0...v1.5.1 [1.5.0]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.4.0...v1.5.0 [1.4.0]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.3.1...v1.4.0 [1.3.1]: https://github.com/codeclocker/codeclocker-intellij-plugin/compare/v1.3.0...v1.3.1 diff --git a/README.md b/README.md index a57fb0a..49eca8b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,27 @@ # CodeClocker – IntelliJ Plugin for Tracking Developer Activity ![Build](https://github.com/codeclocker/codeclocker-intellij-plugin/actions/workflows/gradle.yml/badge.svg) -[![Version](https://img.shields.io/jetbrains/plugin/v/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/26962) -[![Downloads](https://img.shields.io/jetbrains/plugin/d/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/26962) +[![Version](https://img.shields.io/jetbrains/plugin/v/26962.svg)](https://plugins.jetbrains.com/plugin/26962) +[![Downloads](https://img.shields.io/jetbrains/plugin/d/26962.svg)](https://plugins.jetbrains.com/plugin/26962) ## CodeClocker Time Tracker -CodeClocker automatically tracks your coding time and activity, displaying it in the IDE status bar and on the [CodeClocker Hub](https://hub.codeclocker.com/). +Plugin automatically tracks your coding time and activity, displaying it in the IDE status bar. +Optionally, sync your data to the [CodeClocker Hub](https://hub.codeclocker.com/) for web dashboards and team features. ### Features +#### Local Features (No API Key Required) + * **Coding Time Tracking** – Automatically records time spent on each project. * **Daily & Weekly Goals** – Set personalized coding time goals and track your progress. Get notified when you reach your targets. * **VCS Added & Removed Lines** – Tracks added and removed lines in your version control system. -* **IDE Status Bar Widget** – Displays your current coding activity and goal progress directly in the IDE status bar for quick, at-a-glance monitoring. +* **IDE Status Bar Widget** – Displays your current coding activity and daily goal progress directly in the IDE status bar for quick, at-a-glance monitoring. + +#### Hub Features (Optional – Requires API Key) + * **Personal Activity Web Dashboard** – Visualizes your coding activity in a web dashboard on [CodeClocker Hub](https://hub.codeclocker.com/). * **Team Dashboard** – Provides team management and monitoring on [CodeClocker Hub](https://hub.codeclocker.com/) for collective coding activity: * **Team Statistics** – Presents aggregated metrics, including total time and daily averages. @@ -28,10 +34,10 @@ CodeClocker automatically tracks your coding time and activity, displaying it in ## Installation - Using the IDE built-in plugin system: - + Settings/Preferences > Plugins > Marketplace > Search for "CodeClocker" > Install - + - Using JetBrains Marketplace: Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26962) and install it by clicking the Install to ... button in case your IDE is running. @@ -44,17 +50,21 @@ CodeClocker automatically tracks your coding time and activity, displaying it in Download the [latest release](https://github.com/codeclocker/codeclocker-intellij-plugin/releases/latest) and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk... -## API Key Activation +## API Key Activation (Optional) + +**Note:** The API key is only required if you want to sync your data to [CodeClocker Hub](https://hub.codeclocker.com/) for web dashboards and team features. All local features (time tracking, goals, status bar widget) work without an API key. + +To enable Hub integration: -1. After [installation](#installation), a dialog will prompt you to enter your CodeClocker API key. - Click "Get API Key" to be redirected to the [API Key page on CodeClocker Hub](https://hub.codeclocker.com/api-key). - Copy your API key from this page. +1. After [installation](#installation), a dialog will prompt you to enter your CodeClocker API key. + Click "Get API Key" to be redirected to the [API Key page on CodeClocker Hub](https://hub.codeclocker.com/api-key). + Copy your API key from this page. 2. Return to your running IntelliJ IDE, paste the copied API key into the dialog window, and click "OK". -Once set up, CodeClocker will automatically track your coding activity and report it to [CodeClocker Hub](https://hub.codeclocker.com). -If your API key status initially shows "Inactive: No received data yet," don’t worry—it may take up to a minute for activity tracking to start. +Once set up, CodeClocker will automatically track your coding activity and report it to [CodeClocker Hub](https://hub.codeclocker.com). +If your API key status initially shows "Inactive: No received data yet," don't worry—it may take up to a minute for activity tracking to start. Once active, it will update to "Active: Receiving data". -If you need to open the API Key dialog window in your IntelliJ IDE (for example, you accidentally closed it during initial plugin installation), then go to **Tools > CodeClocker API Key** at the top of the dropdown list. +If you skipped the initial prompt or need to add/update your API key later, go to **Tools > CodeClocker API Key** at the top of the dropdown list. ![API key menu](docs/media/api-key-menu.jpg) diff --git a/gradle.properties b/gradle.properties index 10b89ee..2504984 100644 --- a/gradle.properties +++ b/gradle.properties @@ -4,7 +4,7 @@ pluginGroup = com.codeclocker pluginName = CodeClocker pluginRepositoryUrl = https://github.com/codeclocker/codeclocker-intellij-plugin # SemVer format -> https://semver.org -pluginVersion = 1.5.1 +pluginVersion = 1.5.2 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html pluginSinceBuild = 252