README: Add some stuff about what FusionScript is

Author: RyanSquared

README.md

@@ -1,10 +1,68 @@
 # FusionScript [![Build Status](https://travis-ci.org/RyanSquared/fusionscript.svg?branch=master)](https://travis-ci.org/RyanSquared/fusionscript)
 The programming language of ultimate dankliness
 
-**Warning:** This project is very recently released and possibly has many bugs.
-If your code does not compile, it is *very* likely a problem in the compiler
-instead of your code. Please feel free to add an issue if any errors arise that
-you believe were caused by the compiler.
+**Warning:** This project is very unstable and possibly has many bugs.  If your
+code does not compile, it is *very* likely a problem in the compiler or a
+change in the language instead of your code. Please feel free to add an issue
+if any errors arise that you believe were caused by the compiler.
+
+## What is FusionScript?
+
+FusionScript is a language that runs on the Lua runtime (currently, by
+transpiling to Lua and then using a Lua interpreter) inspired by C++, Python,
+and Lua. Eventually, FusionScript will compile to a modified Lua 5.3 bytecode
+and run on a modified Lua VM.
+
+FusionScript offers an improved runtime type checking system (that
+checks between both native Lua types, as well as instances of a class) by using
+the [standard library](/RyanSquared/stdlib)'s `assert.is()` method. Eventually,
+runtime type checking may be implemented using syntax similar to Pythonic type
+hints and checked using bytecode instructions.
+
+FusionScript also has a class system, with the ability to inherit values from a
+superclass as well as an "interface" system that when used (see below) will
+ensure that classes implement certain methods. Below is an example that closely
+mirrors the standard library's scope module:
+
+```fuse
+interface IScope { descope; with; }
+class Scope {
+	with(fn)=> {
+		fn(self);
+	}
+}
+
+-- Example:
+
+local lfs = require("lfs");
+
+class UseDir extends Scope implements IScope {
+	descope()=> lfs.chdir(@old_dir);
+	__init(directory)=> {
+		@old_dir = lfs.currentdir();
+		@dir = directory;
+		lfs.chdir(directory);
+	}
+}
+
+UseDir("/tmp"):with(\=> {
+	File("thing.txt"):with(\file-> {
+		file:write("Hello World!\n");
+	});
+});
+```
+
+There is also implemented an easier way to use generators / iterators using the
+`async` and `yield` functions:
+
+```
+async gen_numbers(low = 1, high)->
+	for (i=low, high)
+		yield i;
+
+for (number in gen_numbers(1, 10))
+	print(number);
+```
 
 ## Commands
 

docs/topics/FusionScript.md.html

@@ -32,6 +32,7 @@ <h1>FusionScript</h1>
 
 <h2>Contents</h2>
 <ul>
+<li><a href="#What_is_FusionScript_">What is FusionScript? </a></li>
 <li><a href="#Commands">Commands </a></li>
 <li><a href="#Examples">Examples </a></li>
 </ul>
@@ -67,10 +68,71 @@ <h2>Programs</h2>
 <h1>FusionScript <a href="https://travis-ci.org/RyanSquared/fusionscript"><img src="https://travis-ci.org/RyanSquared/fusionscript.svg?branch=master" alt="Build Status"/></a></h1>
 <p>The programming language of ultimate dankliness</p>
 
-<p><strong>Warning:</strong> This project is very recently released and possibly has many bugs.
-If your code does not compile, it is <em>very</em> likely a problem in the compiler
-instead of your code. Please feel free to add an issue if any errors arise that
-you believe were caused by the compiler.</p>
+<p><strong>Warning:</strong> This project is very unstable and possibly has many bugs.  If your
+code does not compile, it is <em>very</em> likely a problem in the compiler or a
+change in the language instead of your code. Please feel free to add an issue
+if any errors arise that you believe were caused by the compiler.</p>
+
+<p><a name="What_is_FusionScript_"></a></p>
+<h2>What is FusionScript?</h2>
+
+<p>FusionScript is a language that runs on the Lua runtime (currently, by
+transpiling to Lua and then using a Lua interpreter) inspired by C++, Python,
+and Lua. Eventually, FusionScript will compile to a modified Lua 5.3 bytecode
+and run on a modified Lua VM.</p>
+
+<p>FusionScript offers an improved runtime type checking system (that
+checks between both native Lua types, as well as instances of a class) by using
+the <a href="/RyanSquared/stdlib">standard library</a>'s <code>assert.is()</code> method. Eventually,
+runtime type checking may be implemented using syntax similar to Pythonic type
+hints and checked using bytecode instructions.</p>
+
+<p>FusionScript also has a class system, with the ability to inherit values from a
+superclass as well as an "interface" system that when used (see below) will
+ensure that classes implement certain methods. Below is an example that closely
+mirrors the standard library's scope module:</p>
+
+
+<pre>
+interface IScope { descope; with; }
+class Scope {
+    with(fn)=&gt; {
+        fn(self);
+    }
+}
+
+<span class="comment">-- Example:
+</span>
+<span class="keyword">local</span> lfs = <span class="global">require</span>(<span class="string">"lfs"</span>);
+
+class UseDir extends Scope implements IScope {
+    descope()=&gt; lfs.chdir(@old_dir);
+    __init(directory)=&gt; {
+        @old_dir = lfs.currentdir();
+        @dir = directory;
+        lfs.chdir(directory);
+    }
+}
+
+UseDir(<span class="string">"/tmp"</span>):with(\=&gt; {
+    File(<span class="string">"thing.txt"</span>):with(\file-&gt; {
+        file:write(<span class="string">"Hello World!\n"</span>);
+    });
+});
+</pre>
+
+
+<p>There is also implemented an easier way to use generators / iterators using the
+<code>async</code> and <code>yield</code> functions:</p>
+
+<pre><code> async gen_numbers(low = 1, high)-&gt;
+    for (i=low, high)
+        yield i;
+
+ for (number in gen_numbers(1, 10))
+    print(number);
+</code></pre>
+
 
 <p><a name="Commands"></a></p>
 <h2>Commands</h2>
@@ -250,7 +312,7 @@ <h3>Building</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2017-05-08 19:58:29 </i>
+<i style="float:right;">Last updated 2017-05-09 20:46:56 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>