From 996b7682bf5267ff4d0aa2647e531dbb9c37e200 Mon Sep 17 00:00:00 2001 From: elvis-ndubuisi Date: Wed, 13 Sep 2023 21:28:55 +0100 Subject: [PATCH] docs: :memo: update extension documentation page --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d60330d..4aa3e20 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,35 @@

GitHub Repo stars GitHub package.json version (subfolder of monorepo) + Github

Welcome to "Work Stamp," an extension designed to help you keep track of your time while working on specific projects or tasks within Visual Studio Code. +## Commands + +- `WK: START/STOP`: starts or stops timer + ## Features -- Start and stop a timer to track your work on a particular project. -- Display elapsed time in the status bar. -- Preview timestamp data -- [ ] Configurable colors to indicate the timer's running and stopped states. +- Tracks your active work time and total work time differently. +- Tracks coding activity automatically or via using a command. +- Automatically saves tracked time project when vscode is closed. +- Saves time stamp information locally. +- Display elapsed time in the status bar with tooltip message. + +## Extension Settings + +- `work-stamp.autoStart`: starts work stamp when typing begins if set to `true`. Default: `true` +- `work-stamp.delayDuration`: delay between typing activities before active work timer pauses(in minutes). Default: `10` minutes. + +## TODO -For example if there is an image subfolder under your extension project workspace: +- [ ] Preview all projects timestamp and summary logs in webview. +- [ ] Preview specific project timestamp and summary log +- [ ] Backup log information to custom REST endpoint _(only if specified by a user)_ +- [ ] Display active work elapsed time and total elapsed time message tooltip message. +- [ ] Add break reminder ## Requirements