From 8d59bbdebcca2293d5b3b1da903c39845f7ba1a9 Mon Sep 17 00:00:00 2001
From: Christian Mollekopf <chrigi_1@fastmail.fm>
Date: Fri, 30 Oct 2015 19:41:01 +0100
Subject: docs

---
 docs/extendingakonadi.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 docs/extendingakonadi.md

(limited to 'docs/extendingakonadi.md')

diff --git a/docs/extendingakonadi.md b/docs/extendingakonadi.md
new file mode 100644
index 0000000..fe38e87
--- /dev/null
+++ b/docs/extendingakonadi.md
@@ -0,0 +1,11 @@
+## Steps to add support for new types
+* Add new type to applicationdomaintypes.h and implement `getTypenName()`
+* Implement `TypeImplementation<>` for updating indexes etc.
+* Add a type.fbs default schema for the type
+
+## Steps for adding support for a type to a resource
+* Add a TypeAdaptorFactory, which can either register resource specific mappers, or stick to what the default implementation in TypeImplementation provides
+* Add a TypeFacade that injects the TypeAdaptorFactory in the GenericFacade
+* Register the facade in the resource
+* Add synchronization code that creates the relevant objects
+
-- 
cgit v1.2.3