[doc] Update README
authorDenis Laxalde <denis.laxalde@logilab.fr>
Wed, 17 Dec 2014 15:07:56 +0100
changeset 41 c7556306b72d
parent 40 d7f97a999d12
child 42 70deedd11ff0
[doc] Update README
README
--- a/README	Thu Dec 18 11:41:18 2014 +0100
+++ b/README	Wed Dec 17 15:07:56 2014 +0100
@@ -6,18 +6,16 @@
 Configuration
 -------------
 
-The cube essentially provides an adapter ``ICKANPublishable`` which relies on
-a ``ckan_dataset_id`` attribute on the adapted entity. As its name suggests,
-the latter is used to relate a CubicWeb entity to a CKAN dataset (the
-fundamental entity type in CKAN data model). Most of the synchronization to
-the CKAN instance is done in hooks so usually one would set tight security
-rules for this attribute, e.g.:
-::
+The cube essentially provides hooks to push data in a CKAN instance. The
+mapping from CubicWeb entities is handled by adapters which themselves rely on
+dedicated attributes on the entities:
 
-    class MyEntity(EntityType):
-        ckan_dataset_id = String(
-            description=_('identifier of corresponding CKAN dataset'),
-            __permissions__={'read': ('managers', 'users', 'guests'),
-                             'add': (),
-                             'update': ()},
-            )
+*   ``ICKANDataset`` adapter relies on a ``ckan_dataset_id`` attribute on the
+    adapted entity. As its name suggests, the latter is used to relate a
+    CubicWeb entity to a CKAN dataset (the fundamental entity type in CKAN
+    data model).
+
+*   ``ICKANResource`` adapter relies on a ``ckan_resource_id`` attribute. It
+    is used to related some CubicWeb entity type to a CKAN resource.
+
+See ``test/data`` for a minimal example.