caio.co/de/cantine

Update README

Id
07a0122136d50fc6a75d6ce9538faaebe56d6ab0
Author
Caio
Commit time
2020-01-09T21:37:47+01:00

Modified README.markdown

@@ -33,3 +33,16
* `cantine::database`: A memory-mapped file used as database with the
index stored in a separate log file and payload serialized as
`bincode`
+
+* `cantine::index`: What actually drives the recipe index, doing all
+ the custom pagination and sorting logic. It's where most of the
+ code from `tique` gets used.
+
+## Instructions
+
+You can use the sample data to run a tiny version of the API:
+
+```bash
+cargo run --bin load /tmp/cantine < cantine/tests/sample_recipes.jsonlines
+RUST_LOG=debug cargo run /tmp/cantine
+```