diff --git a/README.md b/README.md index ab6fd07..a7addd9 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ This is a set of scripts. -- **The client** script tracks study sessions and syncs them with a CalDAV calendar. +- **The cli client** script tracks study sessions and syncs them with a CalDAV calendar. +- **The apple shortcut client** allows - **The server** script reads from said CalDAV calendar and serves a nice-looking web UI and API endpoint. ## Usage -### Client +### Clients + +#### cli script A very simple implementation, but a good demonstration of the power of using CalDAV as a DB. @@ -17,6 +20,17 @@ A very simple implementation, but a good demonstration of the power of using Cal 4. The new session will start and display a live timer. To stop it, send `SIGINT` (Ctrl+C). 5. You will be asked if you want to sync the session (y|n). +#### Apple Shortcut +**Requirement:** Toolbox Pro app + +`Start Learning`: Lets you select a subject and saves it, together with a timestamp, to a global (Toolbox Pro) variable. + +`Stop Learning`: Creates a calendar event from the session stored in the global variable. + +All with fancy menus, of course. + + + ### Server The server is written in Python using Flask. It grabs the calendar events via CalDAV and renders a nice-looking UI. diff --git a/client/apple_shortcut/Start Learning.shortcut b/client/apple_shortcut/Start Learning.shortcut new file mode 100644 index 0000000..953cf62 Binary files /dev/null and b/client/apple_shortcut/Start Learning.shortcut differ diff --git a/client/apple_shortcut/Stop Learning.shortcut b/client/apple_shortcut/Stop Learning.shortcut new file mode 100644 index 0000000..2b7c52c Binary files /dev/null and b/client/apple_shortcut/Stop Learning.shortcut differ diff --git a/client/.env.example b/client/cli/.env.example similarity index 100% rename from client/.env.example rename to client/cli/.env.example diff --git a/client/studywatch-cli.py b/client/cli/studywatch-cli.py similarity index 100% rename from client/studywatch-cli.py rename to client/cli/studywatch-cli.py