From a79e7c9ceb877ffa1a354c3bd95f5dcfe08563ac Mon Sep 17 00:00:00 2001
From: "Robert G. Jakabosky" <bobby@sharedrealm.com>
Date: Fri, 18 Feb 2011 22:10:10 -0800
Subject: [PATCH] Add instructions on how to run benchmarks.

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4c5d9af..3973769 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,34 @@ Installation
 ============
 
 <pre>
-$ make install
+$ luarocks install https://github.com/Neopallium/lua-zmq/raw/master/rockspecs/lua-zmq-scm-1.rockspec
 </pre>
 
+Running benchmarks
+==================
+
+When running the benchmarks you will need run two different scripts (one 'local' and one 'remote').  Both scripts can be run on the same computer or on different computers.  Make sure to start the 'local' script first.
+
+Throughput benchmark:
+<pre>
+# first start local script
+$ luajit-2 perf/local_thr.lua "tcp://lo:5555" 50 1000000
+
+# then in another window start remote script
+$ luajit-2 perf/remote_thr.lua "tcp://localhost:5555" 50 1000000
+</pre>
+
+Latency benchmark:
+<pre>
+# first start local script
+$ luajit-2 perf/local_lat.lua "tcp://lo:5555" 1 100000
+
+# then in another window start remote script
+$ luajit-2 perf/remote_lat.lua "tcp://localhost:5555" 1 100000
+</pre>
+
+You can disable the FFI support when running under LuaJIT2 by passing a forth parameter "disable_ffi"
+
 API
 ===