1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2429da3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+gif-encode
+==========
+
+
+```js
+var encoder = new GifEncoder()
+
+encoder.on("quantized", function(url){
+  status("encoding")
+  encoder.encode()
+})
+
+encoder.on("encoded-frame", function(done,count){
+  status("encoded " + done + " / " + count)
+})
+
+encoder.on("rendered", function(bytes){
+  status(filesize(bytes.length))
+})
+
+encoder.on("rendered-url", function(url){
+  var image = new Image ()
+  lastGif = image.src = url
+	$("#workspace canvas").hide()
+  $("#workspace").append(image)
+  $("#uploaded-url").hide().val("")
+	$("#uploaded-url + br").hide()
+  $("#save,#upload,#rendered").show()
+  $("#pause,#render,#add-frame,#save,#upload").enable()
+  $("#render").html("render gif")
+  rendering = false
+  pause(true)
+})
+
+
+function render (frames) {
+	rendering = true
+
+  encoder.reset()
+
+	var delay = 60 // milliseconds
+
+  for (var i = 0; i < frames.length; i++){
+    encoder.addFrame(frame.canvas, delay)
+  }
+
+  try {
+    encoder.encode()
+  } catch (e) {
+    rendering = false
+    status(e)
+    throw e
+  }
+}
+
+```