Permalink
Browse files

fixed: Documentation.

  • Loading branch information...
1 parent 5e6f77d commit b8cb708ae71c2161c075a3dd3b6402fdd2469e41 @gf3 committed Oct 31, 2010
Showing with 5 additions and 1 deletion.
  1. +5 −1 README.md
View
@@ -21,7 +21,11 @@ Be sure to check out example/example.js
## Documentation
-Basic syntax: `sandbox_instance.run( output, hollaback )`
+Basic syntax: `sandbox_instance.run( code, hollaback )`
+
+`code` is the string of Javascript to be executed.
+
+`hollaback` is a function, and it's called with a single argument, `output`.
`output` is an object with two properties: `result` and `console`. The `result`
property is an inspected string of the return value of the code. The `console`

0 comments on commit b8cb708

Please sign in to comment.