From 5f53d822f0d42e08e740b65a4dcfceab3c15bc16 Mon Sep 17 00:00:00 2001
From: Markus Unterwaditzer <markus@unterwaditzer.net>
Date: Mon, 19 May 2014 19:02:22 +0200
Subject: [PATCH] Copy content of readme to docs

Because their content is going to diverge anyway
---
 README.rst     |  4 ----
 docs/index.rst | 27 ++++++++++++++++++++++++++-
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/README.rst b/README.rst
index d3460a6..c10a608 100644
--- a/README.rst
+++ b/README.rst
@@ -12,13 +12,9 @@ It aims to be for CalDAV and CardDAV what `OfflineIMAP
 <http://offlineimap.org/>`_ is for IMAP.
 
 .. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master
-    :width: 77px
-    :height: 19px
     :target: https://travis-ci.org/untitaker/vdirsyncer
 
 .. image:: https://coveralls.io/repos/untitaker/vdirsyncer/badge.png?branch=master
-    :width: 86px
-    :height: 18px
     :target: https://coveralls.io/r/untitaker/vdirsyncer?branch=master
 
 How to use
diff --git a/docs/index.rst b/docs/index.rst
index 130b7db..652b51b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,4 +1,29 @@
-.. include:: ../README.rst
+==========
+vdirsyncer
+==========
+
+vdirsyncer synchronizes your calendars and addressbooks between two storages.
+The supported storages are CalDAV, CardDAV, arbitrary HTTP resources, `vdir
+<https://github.com/untitaker/vdir>`_ and some more. The documentation contains
+a full `list of supported storages <storages>`.
+
+It aims to be for CalDAV and CardDAV what `OfflineIMAP
+<http://offlineimap.org/>`_ is for IMAP.
+
+How to use
+==========
+
+vdirsyncer requires Python >= 2.7 or Python >= 3.3.
+
+As all Python packages, vdirsyncer can be installed with ``pip``::
+
+    pip install --user vdirsyncer
+
+Then copy ``example.cfg`` 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`` and read on:
 
 Table of Contents
 =================