diff --git a/.gitignore b/.gitignore index b1261e0..ac44709 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ # vendor/ /zeit +.DS_Store diff --git a/README.md b/README.md index 6209e4f..1fe6425 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ make ## Usage -Please make sure to `export ZEIT_DB=~/.config/zeit.db` (or whatever location you would like to have the zeit database at). +Please make sure to `export ZEIT_DB=~/.config/zeit.db` (or whatever location +you would like to have the zeit database at). ### Track activity @@ -67,6 +68,26 @@ zeit erase 14037730-5c2d-44ff-b70e-81f1dcd4eb5f zeit import --help ``` +#### Tyme 3 JSON + +It's possible to import JSON exports from [Tyme 3](https://www.tyme-app.com). +It is important that the JSON is exported with the following options set/unset: + +![Tyme 3 JSON export](documentation/tyme3json.png) + +- `Start`/`End` can be set as required +- `Format` has to be `JSON` +- `Export only unbilled entries` can be set as required +- `Mark exported entries as billed` can be set as required +- `Include non-billable tasks` can be set as required +- `Filter Projects & Tasks` can be set as required +- `Combine times by day & task` **must** be unchecked + +During import, *zeit* will create SHA1 sums for every Tyme 3 entry, which +allows it to identify every imported activity. This way *zeit* won't import the +exact same entry twice. Keep this in mind if you change entries in Tyme and +then import them again into *zeit*. + Example: ```sh diff --git a/documentation/tyme3json.png b/documentation/tyme3json.png new file mode 100644 index 0000000..75e0f80 Binary files /dev/null and b/documentation/tyme3json.png differ