Add info to record a Rserve session.

albertosantini · Nov 14, 2014 · 5372f2d · 5372f2d
1 parent 62e9afe
commit 5372f2d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.markdown b/README.markdown
@@ -130,6 +130,20 @@ options.
         fileName: "node-rio-dump.bin"
     }
 
+It is useful to record a Rserve session to replay it in an environment whitout
+Rserve. For instance,
+
+```
+> var rio=require("./index.js")
+undefined
+> rio.enableRecordMode(true, {fileName: "test/dump/integer-test.bin"});
+undefined
+> rio.evaluate("as.integer(3)")
+undefined
+> 3
+(^C again to quit)
+```
+
 enablePlaybackMode(isPlaybackMode, options)
 ------------------