Skip to content

Commit

Permalink
updated: README.
Browse files Browse the repository at this point in the history
  • Loading branch information
gf3 committed Oct 18, 2010
1 parent bce9521 commit aaba439
Showing 1 changed file with 16 additions and 22 deletions.
38 changes: 16 additions & 22 deletions README.md
Expand Up @@ -13,41 +13,35 @@ A rudimentary javascript sandbox for use with node.js.

Be sure to check out example/example.js

var s = new Sandbox();
s.run('1 + 1 + " apples"', function(output) {
var s = new Sandbox()
s.run( '1 + 1 + " apples"', function( output ) {
// output == "2 apples"
});

## Issues

There seems to be a race condition somewhere which sometimes prevents output from being returned properly.

**Update:** This is no longer an issue with the latest version of node.
})

## Documentation

Coming soon!

Basic syntax: `sandbox_instance.run(code_string, hollaback_function)`
Basic syntax: `sandbox_instance.run( code_string, hollaback_function )`

## installation & running.
## Installation & Running

git http://github.com/gf3/node-sandbox.git
Let's get it!

now instruct git to download submodules (into node-sandbox/vendor)
git clone git://github.com/gf3/node-sandbox.git

cd node-sandbox
git submodule init
And run some examples:

run an example
cd example
node example.js
cd example
node example.js

## run tests
## Tests

npm install async_testing
node spec/sandbox.spec.js
npm install async_testing
node spec/sandbox.spec.js

## Author

Written by [Gianni Chiappetta](http://github.com/gf3) – [gf3.ca](http://gf3.ca)
- Written by [Gianni Chiappetta](http://github.com/gf3) – [gf3.ca](http://gf3.ca)
- Updates by [Dominic Tarr](http://github.com/dominictarr) – [cyber-hobo.blogspot.com](http://cyber-hobo.blogspot.com/)

0 comments on commit aaba439

Please sign in to comment.