add README

[gooswapper] / README.org

diff --git a/README.org b/README.org
new file mode 100644 (file)
index 0000000..2fb0707
--- /dev/null
+++ b/README.org
@@ -0,0 +1,47 @@
+* Gooswapper - Exchange / Google calendar sync
+
+This is an alpha-quality python script that synchronises between
+Exchange and Google calendars. Currently only one-way synchronisation
+(from Exchange to Google) is supported.
+
+** Dependencies
+
+For the google API, install the python3-googleapi package; for
+Exchange, install [[https://github.com/ecederstrand/exchangelib][Exchangelib]] and make sure it's on your Python path
+(the code by default adds ~/upstreams/exchangelib~ ). 
+
+** Usage
+
+#+BEGIN_EXAMPLE
+usage: gooswapper.py [-h] [--auth_host_name AUTH_HOST_NAME]
+                     [--noauth_local_webserver]
+                     [--auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]]
+                     [--logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
+                     [-g GCALID] [-l]
+                     exchuser exchemail
+
+Gooswapper calendar sync
+
+positional arguments:
+  exchuser              Exchange user e.g. 'SANGER\mv3'
+  exchemail             Exchange calendar email e.g. ISGGroup@sanger.ac.uk
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --auth_host_name AUTH_HOST_NAME
+                        Hostname when running a local web server.
+  --noauth_local_webserver
+                        Do not run a local web server.
+  --auth_host_port [AUTH_HOST_PORT [AUTH_HOST_PORT ...]]
+                        Port web server should listen on.
+  --logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
+                        Set the logging level of detail.
+  -g GCALID, --gcalid GCALID
+                        google Calendar ID
+  -l, --loop            keep running indefinitely
+#+END_EXAMPLE
+
+** Bugs / Limitations
+
+See [[file:NOTES.org][NOTES.org]] in the distribution for things that I know need doing;
+feel free to supply patches...