aboutsummaryrefslogtreecommitdiffstats
path: root/doc/model.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/model.md')
-rw-r--r--doc/model.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/model.md b/doc/model.md
index 0aad4789..955aa07a 100644
--- a/doc/model.md
+++ b/doc/model.md
@@ -1,9 +1,17 @@
Entities data model
===================
-If you are not familiar with [git internals](https://git-scm.com/book/en/v1/Git-Internals), you might first want to read about them, as the `git-bug` data model is built on top of them.
+This document explains how git-bug's reusable distributed data structure in git is working. This data structure is capable of:
+- storing an entity and its complete history in git
+- carry signed authorship of editions
+- use git remotes as a medium for synchronisation and collaboration
+- merge conflicts
+- respect the rules you define as to what edition are possible
+- carry attached media
+
+If you are looking for a different format or to see how you can easily make your own, checkout [the example code](../entity/dag/example_test.go).
-In a different format, see how you can easily make your own [distributed data structure](../entity/dag/example_test.go).
+If you are not familiar with [git internals](https://git-scm.com/book/en/v1/Git-Internals), you might first want to read about them, as the `git-bug` data model is built on top of them.
## Entities (bug, author, ...) are a series of edit operations