From 337ff63dbb54f5d54f82b9feddaa925d0415dd23 Mon Sep 17 00:00:00 2001
From: James Roseborough <james.roseborough@luaj.org>
Date: Mon, 30 Dec 2013 00:21:17 +0000
Subject: [PATCH] Improve documentation around loading.

---
 README.html                        | 14 +++++++++++++-
 src/core/org/luaj/vm2/Globals.java |  9 +++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.html b/README.html
index a80cc443..dc7567fd 100644
--- a/README.html
+++ b/README.html
@@ -259,6 +259,18 @@ Loading from a file is done via Globals.loadFile():
 	LuaValue chunk = globals.loadfile("examples/lua/hello.lua");
 </pre>
 
+Chunks can also be loaded from a <code>Reader</code> as text source
+
+<pre>
+	chunk = globals.load(new StringReader("print 'hello, world'"), "main.lua");
+</pre>
+
+or an InputStream to be loaded as text source "t", or binary lua file "b":
+
+<pre>
+	chunk = globals.load(new FileInputSStream("examples/lua/hello.lua"), "main.lua", "bt"));
+</pre>
+
 <p>
 A simple example may be found in
 <pre>
@@ -271,7 +283,7 @@ You must include the library <b>lib/luaj-jse-3.0-beta2.jar</b> in your class pat
 <h2>Run a script in a MIDlet</h2>
 
 <p>
-The for MIDlets the <em>JmePlatform</em> is used instead:
+For MIDlets the <em>JmePlatform</em> is used instead:
 
 <pre>
 	import org.luaj.vm2.*;
diff --git a/src/core/org/luaj/vm2/Globals.java b/src/core/org/luaj/vm2/Globals.java
index 814e958c..bf98bdaf 100644
--- a/src/core/org/luaj/vm2/Globals.java
+++ b/src/core/org/luaj/vm2/Globals.java
@@ -197,6 +197,15 @@ public class Globals extends LuaTable {
 		return load(new StrReader(script), chunkname);
 	}
 	
+	/** Convenience function to load a string value as a script.  Must be lua source.
+	 * @param script Contents of a lua script, such as "print 'hello, world.'"
+	 * @return LuaValue that may be executed via .call(), .invoke(), or .method() calls.
+	 * @throws LuaError if the script could not be compiled.
+	 */
+	public LuaValue load(String script) {
+		return load(new StrReader(script), script);
+	}
+	
 	/** Load the content form a reader as a text file.  Must be lua source. 
 	 * The source is converted to UTF-8, so any characters appearing in quoted literals 
 	 * above the range 128 will be converted into multiple bytes.  */