summaryrefslogtreecommitdiff
path: root/docs.org
diff options
context:
space:
mode:
Diffstat (limited to 'docs.org')
-rw-r--r--docs.org16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs.org b/docs.org
new file mode 100644
index 0000000..3861bd9
--- /dev/null
+++ b/docs.org
@@ -0,0 +1,16 @@
+* actual interface
+** config KEY=VAL...
+** pull-url PATH => URL
+** push-url PATH => URL
+** get-meta PATH => KEY=VAL\n...
+** set-meta PATH KEY=VAL...
+** repo-mode => push|pull
+* ruby interface
+** capabilities: .capabilities() => array
+ Returns an array of arrays. Each item in the array is an array of
+ tokens that make a line.
+** create: .create(id string, meta map) => TODO
+** get-meta: .get_meta() => map
+** set-meta: .set_meta(map) => map
+ Returns the same as `get-meta`
+** <EOF>: .finish()