From 850a6de3de7603e05595c9c98aab03d5072196d7 Mon Sep 17 00:00:00 2001 From: Edward Anderson Date: Mon, 10 Jun 2013 22:46:01 -0400 Subject: [PATCH] Update readme with installation notes and 1.9 mode note Also escape the _ in _why for proper markdown syntax. Closes #8 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 74f121d..545c72a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ JRuby Sandbox ============= -The JRuby sandbox is a reimplementation of _why's freaky freaky sandbox +The JRuby sandbox is a reimplementation of \_why's freaky freaky sandbox in JRuby, and is heavily based on [javasand][1] by Ola Bini, but updated for JRuby 1.6. +## Installation + + gem install jruby_sandbox + ## Prerequisites This gem requires JRuby 1.6. As of the time of this writing, it is known to @@ -40,6 +44,8 @@ core libraries. Note that this is a direct binding to `Kernel#require`, so it will only load ruby stdlib libraries (i.e. no rubygems support yet). +Note that all code in the sandbox will be interpreted in Ruby 1.9 mode. + ## Sandbox::Safe usage Sandbox::Safe exposes an `#activate!` method which will lock down the sandbox, removing unsafe methods. Before calling `#activate!`, Sandbox::Safe is the same as Sandbox::Full.