summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vrátil <dvratil@kde.org>2016-08-05 00:52:19 (GMT)
committerDaniel Vrátil <dvratil@kde.org>2016-08-05 00:52:19 (GMT)
commitaffc3f857e1e2134bb431f2642cd63dbba005c4e (patch)
treecbae7424b1a73b3834ad112a3f5d84a20f96f914
parentbc657216701b92fe45784fe7dc949ab07d2af370 (diff)
Enable docs generation on api.kde.org
-rw-r--r--README.md14
-rw-r--r--metainfo.yaml10
2 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52ad4fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Akonadi Calendar
+
+Akonadi Calendar is a library that effectively bridges the type-agnostic API of
+the Akonadi client libraries and the domain-specific KCalCore library. It provides
+jobs, models and other helpers to make working with events and calendars through
+Akonadi easier.
+
+The most notable class is Akonadi::ETMCalendar, a model built on top of the
+Akonadi::EntityTreeModel which provides filters to only show events from selected
+calendars, iterate over events, including recurrences, provides reverse lookup
+from KCalCore::Incidence to Akonadi::Item and other features.
+
+Besides the model there is for example Akonadi::FreeBusyProviderBase, an interface
+for Akonadi Resources that can provide Free/Busy information.
diff --git a/metainfo.yaml b/metainfo.yaml
index 47fb1b8..664122a 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,5 +1,7 @@
-maintainer:
-description: Akonadi-Calendar library
+name: akonadi-calendar
+fancyname: Akonadi Calendar
+maintainer: dvratil
+description: Akonadi Calendar library
tier: 3
type: functional
platforms:
@@ -12,3 +14,7 @@ libraries:
cmake: "KF5::AkonadiCalendar"
cmakename: KF5AkonadiCalendar
+public_lib: true
+group: kdepim
+platforms:
+ - name: Linux