readme

Author: joshday

README.md

@@ -4,10 +4,36 @@ A Graph Database for Julia, built on top of [SQLite.jl](https://github.com/Julia
 
 ## Quickstart
 
-- *Nodes* and *Edges* must have "properties", even if `nothing`.
-- The types returned by `getindex` (`Node`/`Edge`) have a `props` field that contains the JSON String.
-  - You can read it as whatever type you wish with `JSON3.read(node.props, T)`
+```julia
+using SQLiteGraph
+
+db = DB()
+# SQLiteGraph.DB(":memory:") (0 nodes, 0 edges)
+```
 
+-  Nodes and edges must have "properties" (something that is `JSON3.write`-able), even if its `nothing`.
+- Nodes must have an id (`Int`) in ascending order starting with `1`.
+- Add nodes and edges with `setindex!`
+  - E.g. Node 1: `db[1] = (x=1, y=2)`
+  - E.g. Edge 1 → 2: `db[1, 2] = (a=3, b=4)`
+- Query nodes and edges with `getindex` (as well as `find_nodes`/`find_edges`).
+  - E.g. Nodes 1, 2, and 3: `db[1:3]`
+  - E.g. Edges from 1 to 2 or 3: `db[1, 2:3]`
+  - Returned objects are `Node` or `Edge` (or generator if multiple objects queried):
+  - `Node` and `Edge` are simple structs.  By default, `T` will be `String`.  
+    - To read `props` into Julia as a specific type, use `JSON3.read(node.props, MyType)`.
+  ```julia
+  struct Node{T} 
+      id::Int 
+      props::T 
+  end
+
+  struct Edge{T} 
+      source::Int 
+      target::Int 
+      props::T 
+  end
+  ```
 
 ### Creating a Graph Database