diff --git a/README.md b/README.rst similarity index 71% rename from README.md rename to README.rst index da5e1af..fb95f14 100644 --- a/README.md +++ b/README.rst @@ -1,17 +1,20 @@ -# vdirsyncer +========== +vdirsyncer +========== vdirsyncer synchronizes your calendars and addressbooks between two storages. The supported storages are CalDAV, CardDAV and -[vdir](https://github.com/untitaker/vdir). +`vdir `_. While i use it daily and haven't experienced data loss (even when vdirsyncer crashed), i don't know if the documentation is sufficient. If you have any questions regarding the usage, feel free to open a new issue. -[![Build Status](https://travis-ci.org/untitaker/vdirsyncer.png?branch=master)](https://travis-ci.org/untitaker/vdirsyncer) +.. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master + :target: https://travis-ci.org/untitaker/vdirsyncer It aims to be for CalDAV and CardDAV what -[OfflineIMAP](http://offlineimap.org/) is for IMAP. +`OfflineIMAP `_ is for IMAP. ## How to use diff --git a/setup.py b/setup.py index 3db17bb..6c57fac 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ setup( author_email='markus@unterwaditzer.net', url='https://github.com/untitaker/vdirsyncer', description='A syncronization tool for vdir', - long_description=open('README.md').read(), + long_description=open('README.rst').read(), packages=find_packages(), include_package_data=True, entry_points={