From 7bb8f9f956d2cee72da9976dcee65c9bf5ec08e4 Mon Sep 17 00:00:00 2001 From: Sebastian Nozzi Date: Sun, 17 Dec 2023 20:01:58 +0100 Subject: [PATCH] mention features --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3592087..4c21388 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,16 @@ A MiniScript implementation written in TypeScript. -Works in the browser or on Node.js. +At the moment this project is not published either in a CDN for browser consumption nor as an NPM package to be used in Node.js. You will have to build locally. See section below. -At the moment this project is not published either in a CDN for browser consumption nor as an NPM package to be used in Node.js. You will have to build locally. +## Features + +* Runs both on the browser and Node.js +* Fully passes the "TestSuite.txt" from the official C# implementation +* Performance similar to Mini Micro on the desktop +* Extensible via custom intrinsic functions +* Easy integration with JavaScript, as it uses native JS data-types (except for "map") +* Usable in TypeScript projects (type definitions provided) ## Building @@ -45,8 +52,22 @@ Consult the [examples/nodejs](examples/browser/) folder. Note that you will need to build locally for the examples to work. +## Testing + +The test suites can be run from the command line with: + +``` +npm run test +``` + +Alternatively you can open a browser-based UI with: + +``` +npm run test-ui +``` + ## Acknowledgements Many thanks to the amazing MiniScript community at Discord, for their encouragement during the development of this project. -Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible. \ No newline at end of file +Special thanks go to Joe Strout, author and creator of the MiniScript language and the Mini Micro programming environment. Without his generous help this project would not have been possible.