diary

commit 8b0aca1c2d4f6d29477f7848a45d50e5fe198618
parent bf5c286a3be0cc340fb9e3a483bcdfd42c07ad33
Author: Andreas Gruhler <agruhl@gmx.ch>
Date:   Mon, 31 May 2021 22:29:22 +0200

add oauth2 scopes to readme

Diffstat:
M
README.md
 | 
32
+++++++++++++++++---------------

1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# CLI Diary
+# Diary
 
-This is a text based diary, inspired by [khal](https://github.com/pimutils/khal). Diary entries are stored in raw text. You may say C & ncurses are old, I say paper is older..
+This is a text-based diary, inspired by [khal](https://github.com/pimutils/khal). Journal entries are stored in text files.
 
 ![Diary Demo](https://raw.githubusercontent.com/in0rdr/diary/master/demo.gif)
 
@@ -24,27 +24,25 @@ This is a text based diary, inspired by [khal](https://github.com/pimutils/khal)
 3. Use the keypad or VIM-like shortcuts to move between dates:
 
     ```
-    e, Enter  Edit the current entry
-    d, x      Delete/remove current entry
-    t         Jump to today
-    f         Find specific date
+    e, Enter  edit   current entry
+    d, x      delete current entry
+    s         sync   current entry with CalDAV server
 
     j, down   go forward by 1 week
     k, up     go backward by 1 week
     h, left   go left by 1 day
     l, right  go right by 1 day
+    J         go forward by 1 month
+    K         go backward by 1 month
 
-    N         go to the previous diary entry
-    n         go to the next diary entry
+    t         jump to today
+    f         jump to or find specific day
 
+    N         go to the previous journal entry
+    n         go to the next journal entry
     g         go to start of journal
     G         go to end of journal
 
-    J         Go forward by 1 month
-    K         Go backward by 1 month
-
-    s         Sync changes with CalDAV server
-
     q         quit the program
     ```
 
@@ -181,4 +179,9 @@ The token used to authenticate with the Google API is stored in the file specifi
 ```
 # Google OAuth2 tokenfile
 google_tokenfile = ~/.diary-token
-```
-\ No newline at end of file
+```
+
+The application requires two [OAuth2 scopes](https://developers.google.com/calendar/auth) for CalDAV requests:
+
+1. `https://www.googleapis.com/auth/calendar`: read/write access to Calendars - required to discover the unique hyperlink/URI for the calendar specified by the [configuration key](#Configuration-File) `google_calendar`
+2. `https://www.googleapis.com/auth/calendar.events.owned`: read/write access to Events owned by the user - allows diary to create/read/update/delete events in `google_calendar`