Merge pull request #497 from zeroadam/feature/L10n

[friendica-addons.git] / dav / README.md

diff --git a/dav/README.md b/dav/README.md
index b4e7f3ace02ecb5bce7926d7cfdedd125503ce2e..b86d47fc8e2b44532c74b08b3597086f9fe3f574 100644 (file)
--- a/dav/README.md
+++ b/dav/README.md
@@ -1,4 +1,6 @@
-Calendar with CalDAV Support
+# Calendar with CalDAV Support
+
+**THIS ADDON IS UNSUPPORTED**
 
 This is a rewrite of the calendar system used by the german social network [Animexx](http://www.animexx.de/).
 It's still in a very early stage, so expect major bugs. Please feel free to report any of them, by mail (cato@animexx.de) or Friendica: http://friendica.hoessl.eu/profile/cato
@@ -6,37 +8,38 @@ It's still in a very early stage, so expect major bugs. Please feel free to repo
 At the moment, the calendar system supports the following features:
 - A web-based drag&drop interface for managing events
 - All-Day-Events, Multi-Day-Events, and time-based events
+- Giving the subject, a description, a location and a color for the event (the color is not available through CalDAV, though)
 - Recurrences (not the whole set of options given in the iCalendar spec, but the most important ones)
+- Notification by e-mail. Multiple notifications can be set per event
 - Multiple calendars per user
 - Access to the events using CalDAV (using iPhone, Thunderbird Lightning etc., see below)
 - Read-only access to the friendica-native events (also using CalDAV)
 - The friendica-contacts are made available using CardDAV (confirmed to work with iOS)
-- Giving the subject, a description, a location and a color for the event (the color is not available through CalDAV, though)
+- The events of a calendar can be exported as ICS file. ICS files can be imported into a calendar
 
 
-Internationalization:
+## Internationalization:
 - At the moment, settings for the US and the german systems are selectable (regarding the date format and the first day of the week). More will be added on request.
 - The basic design of the system is aware of timezones; however this is not reflected in the UI yet. It currently assumes that the timezone set in the friendica-installation matches the user's local time and matches the local time set in the user's operating system.
 
-CalDAV device compatibility:
+## CalDAV device compatibility:
 - iOS (iPhone/iPodTouch) works
 - Thunderbird Lightning works
 - Android:
   - aCal (http://andrew.mcmillan.net.nz/projects/aCal) works, available in F-Droid and Google Play
   - CalDAV-Sync (http://dmfs.org/caldav/) works, non-free
 
-Installation
-After activating, serveral tables in the database have to be created. The admin-interface of the plugin will try to do this automatically.
+## Installation
+After activating, serveral tables in the database have to be created. The admin-interface of the addon will try to do this automatically.
 In case of errors, the SQL-statement to create the tables manually are shown in the admin-interface.
 
 
-Functuality missing: (a.k.a. "Roadmap")
+## Functuality missing: (a.k.a. "Roadmap")
 - Sharing events; all events are private at the moment, therefore this system is not a complete replacement for the friendica-native events
 - Attendees / Collaboration
-- ICS Export and Import
 
 
-Used libraries
+## Used libraries
 
 SabreDAV
 http://code.google.com/p/sabredav/
@@ -60,7 +63,7 @@ MIT License
 
 
 
-Author of this plugin (the parts that are not part of the libraries above):
+Author of this addon (the parts that are not part of the libraries above):
 Tobias Hößl
 http://friendica.hoessl.eu/profile/cato
 http://www.hoessl.eu/