From e67c12313881468a8779599fc297110cdcfd8acd Mon Sep 17 00:00:00 2001 From: Guill Lo Date: Mon, 3 Apr 2017 23:47:25 +0800 Subject: [PATCH] Update README.md Update README with new functionalities --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index db5e70e5..7c558589 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # Alfred-Time -Very (very) basic workflow to start and stop timers for [Toggl](https://toggl.com/) and/or [Harvest](https://www.getharvest.com/) services through [Alfred](http://alfredapp.com/). +Basic workflow to start and stop timers for [Toggl](https://toggl.com/) and/or [Harvest](https://www.getharvest.com/) services through [Alfred](http://alfredapp.com/). # Why -I prefer using Toggl for tracking time, I like their dashboard and reports better. But I use Harvest for invoices. So instead of starting both services separately (😴), I did the workflow so I can start and stop all services in one shot. +I prefer using Toggl for tracking time, I like their dashboard and reports better. But I use Harvest for invoices. So instead of handling both services separately (😴), I did the workflow so that I can control both services in one shot. # Current features * Generate and open default workflow config file at first start * Launch edit of workflow config file through Alfred if needed * Start timer for Toggl and/or Harvest (as defined in config) with default project/task/tag +* Start timer for Toggl with choice of project and tag (currently only for Toggl, and only one single tag choosable) * Stop current timer for Toggl and/or Harvest (as defined in config) +* Undo last timer for Toggl and Harvest (if a current timer is running, will stop it and delete it. It no timer is running, delete the last ran timer) +* Sync project and tag data to local cache (currently only for Toggl) # How to use @@ -25,7 +28,11 @@ I prefer using Toggl for tracking time, I like their dashboard and reports bette ![edit](https://github.com/godbout/alfred-time/blob/master/screenshots/time-edit.gif) -* Start timer +* Start timer with default project and tag (with cmd modifier) + +![start-default](https://github.com/godbout/alfred-time/blob/master/screenshots/time-start-default.gif) + +* Start timer with choice of project and tag ![start](https://github.com/godbout/alfred-time/blob/master/screenshots/time-start.gif) @@ -33,6 +40,14 @@ I prefer using Toggl for tracking time, I like their dashboard and reports bette ![stop](https://github.com/godbout/alfred-time/blob/master/screenshots/time-stop.gif) +* Undo last timer + +![undo](https://github.com/godbout/alfred-time/blob/master/screenshots/time-undo.gif) + +* Sync projects and tags to local cache (automatic on first time, then you can resync manually) + +![sync](https://github.com/godbout/alfred-time/blob/master/screenshots/time-sync.gif) + ## Config file The config file contains 3 sections: @@ -52,10 +67,11 @@ The config file contains 3 sections: # Todo -* Allow choice of default project, or not at all -* Allow choice of default tags/tasks, or not at all +* Improve notification messages +* Allow choice of project and task for Harvest * See reports directly in Alfred * See info about current running timer (project, tags/tasks, running time, etc...) +* Some inhouse curl refactoring # Contribute