Skip to content

Commit 7bb8f9f

Browse files
committed
mention features
1 parent 9b188f1 commit 7bb8f9f

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33

44
A MiniScript implementation written in TypeScript.
55

6-
Works in the browser or on Node.js.
6+
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.
77

8-
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.
8+
## Features
9+
10+
* Runs both on the browser and Node.js
11+
* Fully passes the "TestSuite.txt" from the official C# implementation
12+
* Performance similar to Mini Micro on the desktop
13+
* Extensible via custom intrinsic functions
14+
* Easy integration with JavaScript, as it uses native JS data-types (except for "map")
15+
* Usable in TypeScript projects (type definitions provided)
916

1017
## Building
1118

@@ -45,8 +52,22 @@ Consult the [examples/nodejs](examples/browser/) folder.
4552

4653
Note that you will need to build locally for the examples to work.
4754

55+
## Testing
56+
57+
The test suites can be run from the command line with:
58+
59+
```
60+
npm run test
61+
```
62+
63+
Alternatively you can open a browser-based UI with:
64+
65+
```
66+
npm run test-ui
67+
```
68+
4869
## Acknowledgements
4970

5071
Many thanks to the amazing MiniScript community at Discord, for their encouragement during the development of this project.
5172

52-
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.
73+
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.

0 commit comments

Comments
 (0)