Skip to content

Commit 48aa0e2

Browse files
committed
doc: update npm README
1 parent 0862556 commit 48aa0e2

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

wasm/README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,15 @@
1+
![Rust](https://github.com/gengjiawen/monkey-rust/workflows/Rust/badge.svg)
2+
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/gengjiawen/monkey_rust)
3+
14
This lib designed for compiling monkey-parser into WebAssembly and
25
publishing the resulting package to NPM.
36

4-
Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other
5-
templates and usages of `wasm-pack`.
6-
7-
[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
8-
[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html
9-
10-
## Usage
11-
12-
### Build with `wasm-pack build`
13-
14-
```
15-
wasm-pack build
16-
```
17-
18-
### Test in Headless Browsers with `wasm-pack test`
19-
20-
```
21-
wasm-pack test --headless --firefox
22-
```
7+
![The Monkey Programming Language](https://cloud.githubusercontent.com/assets/1013641/22617482/9c60c27c-eb09-11e6-9dfa-b04c7fe498ea.png)
238

24-
### Publish to NPM with `wasm-pack publish`
9+
## What’s Monkey?
2510

26-
```
27-
wasm-pack publish
28-
```
11+
Monkey has a C-like syntax, supports **variable bindings**, **prefix** and **infix operators**, has **first-class** and **higher-order functions**, can handle **closures** with ease and has **integers**, **booleans**, **arrays** and **hashes** built-in.
2912

30-
## Batteries Included
13+
Official site is: https://monkeylang.org/. It's has various implementation languages :).
3114

32-
* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
33-
between WebAssembly and JavaScript.
34-
* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
35-
for logging panic messages to the developer console.
36-
* [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized
37-
for small code size.
15+
There is a book about learning how to make an interpreter: [Writing An Interpreter In Go](https://interpreterbook.com/#the-monkey-programming-language). This is where the Monkey programming language come from.

0 commit comments

Comments
 (0)