Skip to content

Commit

Permalink
mention features
Browse files Browse the repository at this point in the history
  • Loading branch information
sebnozzi committed Dec 17, 2023
1 parent 9b188f1 commit 7bb8f9f
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
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 comments on commit 7bb8f9f

Please sign in to comment.