==========
vdirsyncer
==========

- `Documentation <https://vdirsyncer.pimutils.org/en/stable/>`_
- `Source code <https://github.com/pimutils/vdirsyncer>`_

Vdirsyncer synchronizes your calendars and addressbooks between two storages_.
The most popular purpose is to synchronize a CalDAV/CardDAV server with a local
folder or file. The local data can then be accessed via a variety of programs_,
none of which have to know or worry about syncing to a server.

.. _storages: https://vdirsyncer.pimutils.org/en/latest/config.html#storages
.. _programs: https://vdirsyncer.pimutils.org/en/latest/tutorials/

It aims to be for CalDAV and CardDAV what `OfflineIMAP
<http://offlineimap.org/>`_ is for IMAP.

.. image:: https://travis-ci.org/pimutils/vdirsyncer.svg?branch=master
    :target: https://travis-ci.org/pimutils/vdirsyncer

.. image:: https://codecov.io/github/pimutils/vdirsyncer/coverage.svg?branch=master
    :target: https://codecov.io/github/pimutils/vdirsyncer?branch=master

.. image:: https://badge.waffle.io/pimutils/vdirsyncer.svg?label=ready&title=Ready
    :target: https://waffle.io/pimutils/vdirsyncer

Links of interest
=================

* Check out `the tutorial
  <https://vdirsyncer.pimutils.org/en/stable/tutorial.html>`_ for basic
  usage.

* `Contact information
  <https://vdirsyncer.pimutils.org/en/stable/contact.html>`_

* `How to contribute to this project
  <https://vdirsyncer.pimutils.org/en/stable/contributing.html>`_

* `Donations <https://vdirsyncer.pimutils.org/en/stable/donations.html>`_

License
=======

Licensed under the 3-clause BSD license, see ``LICENSE``.
