Add example config

README.md

@@ -3,6 +3,14 @@ This is work-in-progress.
 A basic syncronization utility for [vdir](https://github.com/untitaker/vdir).
 Should be able to sync both CardDAV and CalDAV in the end.
 
+## How to run
+
+Copy `config.example` to `~/.vdirsyncer/config` and edit it. You can use the
+`VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will
+read the config from.
+
+Run `vdirsyncer --help`.
+
 ## A little bit about the code architecture
 
 There are storage classes which control the access to one vdir-collection and

config.example

@@ -0,0 +1,33 @@
+[general]
+status_path=~/.vdirsyncer/status/
+
+[pair bob]
+# This syncronizes only a single collection/calendar/addressbook
+a = bob_local
+b = bob_remote
+
+[storage bob_local]
+# This represents only a single collection/calendar/addressbook
+type = filesystem
+path = ~/.watdo/tasks/somecalendar/
+#fileext = .ics
+
+[storage bob_remote]
+# This represents only a single collection/calendar/addressbook
+type = caldav
+url = https://owncloud.example.com/remote.php/caldav/calendars/bob/somecalendar/
+username =  # blabla
+password =  # blabla
+
+# Specify a time range which should be syncronized. Either both start_date and
+# end_date or neither have to be set. The default is to syncronize everything.
+# The following example syncronizes from one year in the past to one year in
+# the future.
+
+# All Python expressions are allowed here. The global namespace contains
+# everything from the datetime module. The expression has to evaluate to a
+# datetime.
+#start_date = datetime.now() - timedelta(days=365)
+
+# Here, start_date is also in the namespace.
+#end_date = datetime.now() + timedelta(days=365)

vdirsyncer/cli.py

@@ -123,6 +123,8 @@ def _main(env, file_cfg):
 
     @sync_command.main('[pairs...]')
     def sync_main(context, pairs=None):
+        '''Syncronize the given pairs. If no pairs are given, all will be
+        syncronized.'''
         if pairs is None:
             pairs = list(all_pairs)
         actions = []