From 74102afbded119e64bfdbee629e66a2d05de5131 Mon Sep 17 00:00:00 2001 From: Alexander Willner Date: Wed, 27 Dec 2017 09:03:46 +0100 Subject: [PATCH] slightly enhanced README and added an example on how to use the CSV export --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 827ab9d..4188a8c 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,12 @@ ## Overview -Simple read-only comand-line interface to your Things 3 database. Since Things uses a SQLite database (which should come pre-installed on your Mac) we can simply query it straight from the command line. We only do read operations since we don't want to mess up your data. +Simple read-only comand-line interface to your Things 3 database (incl. CSV export). Since Things uses a SQLite database (which should come pre-installed on your Mac) we can simply query it straight from the command line. We only do read operations since we don't want to mess up your data. ## Installation +You can use [brew](https://brew.sh) to install and later update the script: + ```brew install AlexanderWillner/tap/things.sh``` ## Instructions @@ -49,7 +51,13 @@ OPTIONS: -s|--string String to search for ``` -Example output: +## Examples + +### CSV export and open with Excel + +```things.sh csv > Things3Export.csv ; open Things3Export.csv``` + +### Statistics ``` $ things.sh stat @@ -77,6 +85,7 @@ Days/Task : 39.0 ``` + ## CREDITS * Author : Arjan van der Gaag (script for Things 2) * Author : Alexander Willner (updates for Things 3, added many more commands, a lot refactoring)