From 876e10083c1e0a8566886adffa4605d6249bd17b Mon Sep 17 00:00:00 2001
From: Kartik Thakore <kthakore@alumni.uwo.ca>
Date: Sat, 26 Sep 2020 13:56:40 -0700
Subject: [PATCH] Adding notes for Rune example

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6c25b04782..63230fa5f9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
 # Rune
-Containerization for TinyML Applications on MCU
+
+Rune is a containerization technology for deploying TinyML applications to extremely constraint devices. 
+
+
+## Runefile 
+
+A `Runefile` is similar to `Dockerfile` in that it is a text document that defines capabilities, processing blocks, feature transformation, models and model outputs to assemble the `Rune`. 
+
+A simplistic example of this is would be:
+
+*TODO: refine the below with an exact working version*
+
+```
+FROM runicos/base
+
+CAPABILITY AUDIO audio
+
+PROC_BLOCK runicos/fft fft
+
+MODEL ./example.tflite model
+
+RUN audio fft model
+
+```
+
+In this example a audio with fft (fast fourier transformation) block can be run with the model. 
+
+### Usage
+
+#### Build
+
+Using the `rune` cli you can build containers 
+that are tagged and available.
+
+*List available containers*
+
+`rune container ls`
+
+*Build new containers*
+
+`rune build .`
+
+*Run the containers locally simulated*
+
+`rune exec ${CONTAINER-ID}`
+
+
+
+