Project init

docs/semrack-core.md

@@ -0,0 +1,27 @@
+# Semrack Core
+
+Fourni les entités / fonctionalités suivantes :
+
+- Semdoc : l'entité document, la base de travail 
+- Storage : backend de récupération / stockage des documents
+- Repository : s'interface en amont du storage. Active les fonctionnalité d'interceptions de lecture, d'écriture et recherche 
+- ReadInterceptor : interception du document en lecture
+- WriteInterceptor : interception du document en écriture
+- SearchInterceptor : interception des filtres de recherche
+
+## Semdoc
+
+- uid : identifiant unique dans le rack
+- annotations: écrites uniquement par les intercepteurs
+- métadonnées: écrite par l'utilisateur, peuvent être altérées par les intercepteurs (validation, securité, etc.)
+- directives: lors d'un push, renseigne les intercepteurs sur les actions à mener pour l'écriture du document (versioning, annotations, etc.)
+
+## Directives
+
+### Snapshot
+La directive snapshot permet de créer une capture lors du push du document précédent
+
+    directives: 
+      snapshot: true | false
+      publish: true | false
+