1 files changed, 20 insertions, 0 deletions
diff --git a/rif/README.md b/rif/README.md
new file mode 100644
index 0000000..e99b4c1
--- /dev/null
+++ b/rif/README.md
@@ -0,0 +1,20 @@
+# recipe instruction format (`rif`)
+
+A strongly typed expression format for recipes.
+
+Recipes consist of a schema which specifies available ingredients and
+worksteps, some metadata that is largely computed from the actual
+recipe, but can be queried from the main object, as well as a directed
+graph of ingredient measures and worksteps separated into threads.
+
+A thread is a set of instructions that can be executed by a single
+actor.  Each thread has a set of inputs (ingredients) and an output,
+which is it's own type, a mix of ingredients created by the thread.
+
+
+## How to use
+
+```rust
+let schema = Schema::load("./main.rifs")?;
+let recp = Recipe::
+```