From 1b22cab7dd4027035f4eb0204148a080ae68cae9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Hozda?= <luk.hozda@gmail.com>
Date: Sat, 28 Oct 2017 21:59:14 +0200
Subject: [PATCH] add loops and comments and a list of example scripts and how
 to run them to README

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

diff --git a/README.md b/README.md
index 4c7b5b72..a02a84fa 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,29 @@ Examples can be run with the following command:
 cargo run --example name
 ```
 
+## Example Scripts
+We also have a few examples scripts that showcase Rhai's features, all stored in the `scripts` folder:
+- `array.rhai` - arrays in Rhai
+- `assignment.rhai` - variable declarations
+- `comments.rhai` - just comments
+- `function_decl1.rhai` - a function without parameters
+- `function_decl2.rhai` - a function with two parameters
+- `function_decl3.rhai` - a function with many parameters
+- `if1.rhai` - if example
+- `loop.rhai` - endless loop in Rhai, this example emulates a do..while cycle
+- `op1.rhai` - just a simple addition
+- `op2.rhai` - simple addition and multiplication
+- `op3.rhai` - change evaluation order with parenthesis
+- `speed_test.rhai` - a simple program to measure the speed of Rhai's interpreter
+- `string.rhai`- string operations
+- `while.rhai` - while loop
+
+To run the scripts, you can either make your own tiny program, or make use of the `rhai_runner`
+example program:
+```bash
+cargo run --example rhai_runner scripts/any_script.rhai
+```
+
 # Hello world
 
 To get going with Rhai, you create an instance of the scripting engine and then run eval.
@@ -290,6 +313,17 @@ while x > 0 {
 }
 ```
 
+## Loop
+```rust
+let x = 10;
+
+loop {
+    print(x);
+    x = x - 1;
+	if x == 0 { break; }
+}
+```
+
 ## Functions
 
 Rhai supports defining functions in script:
@@ -337,3 +371,18 @@ let name = "Bob";
 let middle_initial = 'C';
 ```
 
+## Comments
+
+```rust
+let /* intruder comment */ name = "Bob";
+// This is a very important comment
+/* This comment spans
+   multiple lines, so it
+   only makes sense that
+   it is even more important */
+
+/* Fear not, Rhai satisfies all your nesting
+   needs with nested comments:
+   /*/*/*/*/**/*/*/*/*/
+*/
+```