Skip to content

Commit

Permalink
docs: 📝 update extension documentation page
Browse files Browse the repository at this point in the history
  • Loading branch information
elvis-ndubuisi committed Sep 13, 2023
1 parent 7033ff6 commit 996b768
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,35 @@
<p align="center">
<img src="https://img.shields.io/github/stars/elvis-ndubuisi/work-stamp" alt="GitHub Repo stars"/>
<img src="https://img.shields.io/github/package-json/v/elvis-ndubuisi/work-stamp" alt="GitHub package.json version (subfolder of monorepo)"/>
<img src="https://img.shields.io/github/license/elvis-ndubuisi/work-stamp" alt="Github"/>
</p>

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

Expand Down

0 comments on commit 996b768

Please sign in to comment.