From d8832d5825cb7fc4c70b6d1223a8e5bfd427299c Mon Sep 17 00:00:00 2001
From: Denis Knauf <Denis.Knauf@gmail.com>
Date: Wed, 31 Mar 2010 19:32:26 +0200
Subject: [PATCH] Little Doku.

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index e69de29..18df0bb 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,47 @@
+Install
+=======
+
+	gem install Safebox
+
+Usage
+=====
+
+First load the safebox:
+
+	require 'safebox'
+
+The most things in your Safebox are possible:
+
+	value = Safebox.eval "1+2**9"
+	value = Safebox.eval {|| 1+2**8 }
+
+Only some good things are not possible:
+
+	Safebox.eval "$stdout.puts 'I am OK!'"
+
+But, very bad code will not damage your system.
+
+	Safebox.eval "class Unsecure;def self.code() system 'rm *' ; end end; Unsecure.code"
+
+This will raise a SecurityError.
+
+What is with raised exceptions?
+
+	Safebox.eval "raise Exception"
+
+This will print the Exception.
+
+Or if you want to get the Exception:
+
+	ret = Safebox.run "raise Exception"
+	ret # => [:exception, #<Exception>]
+
+What is *Safebox.run*?
+
+	ret = Safebox.run "1+2**9"
+	ret # => [:value, 513]
+
+You get something back, which can be unsafe!
+
+	Safebox.eval( "class A;def to_s() 'Owned!'; end end; A.new").to_s
+	puts Safebox.eval( "class A;def to_s() 'Owned!'; end end; A.new")