From ee97079132c3dc9d7d114194c067e575e40f21b2 Mon Sep 17 00:00:00 2001
From: Christian Krause <christian.krause@idiv.de>
Date: Tue, 28 Mar 2017 10:55:11 +0200
Subject: [PATCH] flesh out README
---
README.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/README.md b/README.md
index 9bbb41f..a1d4e03 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
# Time Tracking Analysis
+
+Analyze time tracking data.
+
+## Dependencies
+
+- JDK 8
+- SQLite 3
+- [Ammonite](http://www.lihaoyi.com/Ammonite/#Ammonite-REPL)
+
+## Usage
+
+1. Create a database for your **debit** work hours:
+
+ ```
+ sqlite3 timetracking.db 'create table debit (day text primary key, hours real)'
+ ```
+
+2. Fill the database with your **debit** work hours:
+
+ ```
+ sqlite3 timetracking.db 'insert into debit (day, hours) values ("2017-03-28", 8)'
+ ```
+
+3. Start analysis:
+
+ ```
+ amm ttanalysis.sc timetracking.db export_all.csv
+ ```
--
GitLab