From d06dd4ca85d063755e41b16592e4bda4beccbb7f Mon Sep 17 00:00:00 2001
From: Markus Unterwaditzer <markus@unterwaditzer.net>
Date: Thu, 28 Apr 2016 00:55:35 +0200
Subject: [PATCH] Add example for metadata sync (#440)

Fix #422
---
 docs/tutorial.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 38bf918..61dd2f7 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -158,3 +158,34 @@ discover`` again to re-fetch this list instead.
 
 .. [2] Because collections are added rarely, and checking for this case before
    every synchronization isn't worth the overhead.
+
+Metadata synchronization
+------------------------
+
+Besides items, vdirsyncer can also synchronize metadata like the addressbook's
+or calendar's "human-friendly" name (internally called "displayname") or the
+color associated with a calendar. For the purpose of explaining this feature,
+let's switch to a different base example. This time we'll synchronize calendars::
+
+    [pair my_calendars]
+    a = my_calendars_local
+    b = my_calendars_remote
+    collections = ["from a", "from b"]
+    metadata = ["color"]
+
+    [storage my_calendars_local]
+    type = filesystem
+    path = ~/.calendars/
+    fileext = .ics
+
+    [storage my_calendars_remote]
+    type = caldav
+
+    url = https://owncloud.example.com/remote.php/caldav/
+    username = bob
+    password = asdf
+
+Run ``vdirsyncer discover`` for discovery. Then you can use ``vdirsyncer
+metasync`` to synchronize the ``color`` property between your local calendars
+in ``~/.calendars/`` and your ownCloud. Locally the color is just represented
+as a file called ``color`` within the calendar folder.