update readme and rockspec.

5 files changed, 106 insertions, 8 deletions

diff --git a/README.md b/README.md
index 018e6b0..9bfef2d 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,42 @@
 # MoonPlus
 
 ![CI](https://github.com/pigpigyyy/MoonPlus/workflows/build-test/badge.svg)  
-MoonPlus is a compiler with features from [Moonscript language](https://github.com/leafo/moonscript) 0.5.0 and could be faster than the original Moonscript compiler. 
+MoonPlus is a compiler with features from [Moonscript language](https://github.com/leafo/moonscript) 0.5.0 and implementing new features to make Moonscript more up to date. 
+
+Since original Moonscript has been used to write web framework [lapis](https://github.com/leafo/lapis) and run a few business web sites like [itch.io](https://itch.io) and [streak.club](https://streak.club) with some large code bases. The original language is getting too hard to adopt new language features for those may break the stablility for existing applications.
+
+So MoonPlus is a new code base for pushing the language to go forward and may be a playground to try introducing new language syntax or programing paradigms to make Moonscript language more expressive and productive.
 
 ## Features
 
 * No other dependencies needed except modified **parserlib** library from Achilleas Margaritis with some performance enhancement. **lpeg** library is no longer needed.
 * Written in C++17.
 * Support full Moonscript language features, generate the same Lua codes with original compiler.
-* Reserve line numbers from source Moonscript codes in compiled Lua codes to help with debugging.
+* Reserve line numbers from Moonscript sources in compiled Lua codes to help with debugging.
+
+## Installation
+
+Install [luarocks](https://luarocks.org), a package manager for Lua modules. Then install Lua module with
+```sh
+> luarocks install moonplus
+```
+
+## Usage
+
+```Lua
+require("moonp")("main") -- require `main.moon`
+
+local moonp = require("moonp")
+print(moonp.to_lua[[
+f = ->
+  print "hello world"
+f!
+]])
+```
 
 ## Changes
 
-The original Moonscript language 0.5.0 support can be found in the `0.5.0` branch. Moonscript with new features is in the master branch. Here are the new features introduced in MoonPlus
+The original Moonscript language 0.5.0 support can be found in the `0.5.0` branch. Moonscript with new features is in the master branch. Here are the new features introduced in MoonPlus.
 
 * Multi-line comment.
 * Usage for symbol `\` to escape new line. Will compile codes:
@@ -179,6 +203,59 @@ for _index_0 = 1, #_list_0 do
 end
 ```
 
+* Expression list appears at the middle of code block is not allowed. For codes like:
+```Moonscript
+-- Moonscript 0.5.0
+f = (x)->
+  "abc",123 -- valid meaningless codes
+  x + 1
+```
+in original Moonscript compiles to:
+```Lua
+local f
+f = function(x)
+ local _ = "abc", 123 -- report error in MoonPlus
+ return x + 1
+end
+```
+
+This feature may lead to some silenced errors. For example:
+```Moonscript
+-- expected codes
+tree\addChild with Node!
+  \addChild subNode
+  
+-- in original Moonscript, codes will still run after adding a break
+tree\addChild
+with Node!
+   \addChild subNode
+```
+the original Moonscript will compile these codes to:
+```Lua
+-- expected codes
+tree:addChild((function()
+  do
+    local _with_0 = Node()
+    _with_0:addChild(subNode)
+    return _with_0
+  end
+end)())
+
+-- codes added with a break will still run
+local _ -- report error in MoonPlus instead of creating
+do      -- an anonymous function to bind the object method
+  local _base_0 = tree
+  local _fn_0 = _base_0.addChild
+  _ = function(...)
+    return _fn_0(_base_0, ...)
+  end
+end
+do
+  local _with_0 = Node()
+  _with_0:addChild(subNode)
+end
+```
+
 ## Standalone Compiler Usage
 
 Test compiler with `make test`.
diff --git a/moonplus-0.1-1.rockspec b/moonplus-0.1-1.rockspec
index aeebe69..e1dd086 100644
--- a/moonplus-0.1-1.rockspec
+++ b/moonplus-0.1-1.rockspec
@@ -6,8 +6,10 @@ source = {
 description = {
         summary = "MoonPlus is a compiler for Moonscript written in C++.",
         detailed = [[
-        MoonPlus is a compiler with features from Moonscript language 0.5.0 and more advanced features. could be faster than the original Moonscript compiler. ]],
+        MoonPlus is a compiler with features from Moonscript language 0.5.0 and implementing new features to make Moonscript more up to date. ]],
         homepage = "https://github.com/pigpigyyy/MoonPlus",
+        maintainer = "Li Jin <dragon-fly@qq.com>",
+        labels = {"moonscript","cpp","transpiler"},
         license = "MIT"
 }
 dependencies = {
diff --git a/src/MoonPlus.h b/src/Moonscript.h
index da5f3ac..6e84552 100644
--- a/src/MoonPlus.h
+++ b/src/Moonscript.h
@@ -1,4 +1,25 @@
 R"moonscript_codes(
+--[[
+Copyright (C) 2020 by Leaf Corcoran, modified by Li Jin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.]]
+
 import "moonp"
 import concat, insert, remove from table
 unpack = unpack or table.unpack
diff --git a/src/StackTracePlus.h b/src/StackTracePlus.h
index 1a909fd..202ae22 100644
--- a/src/StackTracePlus.h
+++ b/src/StackTracePlus.h
@@ -1,8 +1,6 @@
 R"lua_codes(
 --[[
-The MIT License
-
-Copyright (c) 2010 Ignacio Burgueño
+Copyright (c) 2010 Ignacio Burgueño, modified by Li Jin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/src/moonp.cpp b/src/moonp.cpp
index a6c99df..cb53b55 100644
--- a/src/moonp.cpp
+++ b/src/moonp.cpp
@@ -182,7 +182,7 @@ extern "C" {
 #include "lauxlib.h"
 
 static const char moonplusCodes[] =
-#include "MoonPlus.h"
+#include "Moonscript.h"
 
 static int init_moonplus(lua_State* L) {
         MoonP::MoonConfig config;