Commit 97484654491fa58fd8c44f40727574c60b357b67
2023-07-11T12:20:47
README.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
diff --git a/README.md b/README.md
index 4d5b4ea..8137501 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ It features :
* logging and replay of transactions to/from disk
* dumping and loading the database to/from disk
+---
Requirements
------------
@@ -21,6 +22,7 @@ You will need :
* https://git.kmx.io/facts-db/cl-compare
* https://git.kmx.io/facts-db/cl-rollback
+---
Usage
-----
@@ -38,6 +40,8 @@ Adds facts (triples) to the database. Triples can be grouped by subject.
:director "David Hand"))
```
+or either
+
```common-lisp
(facts:add (?movie :is-a :movie
:title "Blade Runner"
@@ -54,6 +58,7 @@ Adds facts (triples) to the database. Triples can be grouped by subject.
The second version with `?movie` will generate an anonymous symbol prefixed with `movie-`.
It is considered a more clean and efficient way to abstract identifiers.
+---
### FACTS:RM &rest SPECS
@@ -61,6 +66,7 @@ It is considered a more clean and efficient way to abstract identifiers.
(facts:rm (?movie :actor "Harison Ford"))
```
+---
### FACTS:WITH SPECS &body BODY
@@ -109,28 +115,28 @@ results.
"Snow White" :IS-A :MOVIE
```
-
-TODO
-----
-
- - binding of negation : :not resulting from another binding
- - barriers / hooks : functions that will be called when a spec is added
- or removed.
-
-```
+---
### FACTS:\*DB\*
The current facts database.
+---
+
### FACTS:CLEAR-DB
Clears the database from every facts.
+---
+
### FACTS:SAVE-DB &key INTO (READABLY T)
Dump the database facts into filespec INTO.
+---
+
### FACTS:LOAD-DB SRC
Load the facts from SRC into \*db\*.
+---
+
### FACTS:WITH-TRANSACTION &body BODY
Enclose BODY database operations into a transaction.
@@ -138,3 +144,12 @@ A transaction ensures that all database operations will succeed or be
reverted using their respective rollback functions.
Transactions can be nested safely.
+
+---
+
+TODO
+----
+
+ - binding of negation : :not resulting from another binding
+ - barriers / hooks : functions that will be called when a spec is added
+ or removed.