mevento 1.0.0 → 1.2.2

package/README.md

@@ -1,24 +1,59 @@
 # Mevento
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.1.0.
+Mevento is a tiny VM one single file that handles `MEvento code` executions inside JS engine. `MEvento` is simple programming language that allows developers exposing an app host function, that way they have the ability to dynamically execute simple script that call host function.
 
-## Code scaffolding
+The VM uses a AST Walker to execute MEvento script, so of course the performace is not its concern a lot.
 
-Run `ng generate component component-name --project mevento` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project mevento`.
-> Note: Don't forget to add `--project mevento` or else it will be added to the default project in your `angular.json` file. 
+## MEvento code syntax
+Syntaxically MEvento is a c-like language, but very limited: no function declaration, no class, just assignation, function call and conditional check.
 
-## Build
+```js
+a = 12
+a = 23
+b = functon1()
+c = function2()
+d = a + b
+if(a == b) {
+    log('a = b')
+} else {
+    log("a != b")
+}
+```
 
-Run `ng build mevento` to build the project. The build artifacts will be stored in the `dist/` directory.
+## How to use
+The host application can expose functions through Mevento VM that way:
+```ts
+import {MEvento} from 'mevento';
+MEvento.register('log', (args) => console.log); // exposes console.log through MEvento as log function
+MEvento.register('cos2', (args) => Math.cos);
+```
 
-## Publishing
+Let's assume you want to execute a `MEvento code`: 
 
-After building your library with `ng build mevento`, go to the dist folder `cd dist/mevento` and run `npm publish`.
+```ts
+import {MEvento} from 'mevento';
 
-## Running unit tests
+const mevento = MEvento.newInstance();
 
-Run `ng test mevento` to execute the unit tests via [Karma](https://karma-runner.github.io).
+mevento.execute(`log("molo")`)
 
-## Further help
+```
+
+`MEvento` instance execution is syncrhrone, that's to say, if you wan to consume `async` function exposed through Mevento, you nee to use `MEventoAsync` instead.
+
+
+```ts
+import {MEvento} from 'mevento';
+
+MEvento.register('async', async (args) => await asyncF(args[0]));
+const mevento = MEventoAsync.newInstance();
+
+await mevento.execute(`async("molo")`)
+
+```
+`execute` method on `MEventoAsync` instance return a `Promise`.
+
+
+## Notes
+MEvento does not have scope variables, all variables are visible everywhere.  
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.