Skip to content

Commit 6c3fc41

Browse files
committed
docs: updated docs
1 parent 4924a53 commit 6c3fc41

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Aeon ⏳✨
22

33
Aeon is an extremely tiny, but easy to use WebAssembly runtime, built for demonstration and educational purposes.
4-
It is so tiny that supports only additions, subtractions and i32 integers.
4+
It is so tiny that can work only with i32 integers.
55

66
It is part of the <a href="https://github.com/thomscoder/luna" target="_blank">Luna</a> project, so they integrate very very well.
77
Its purpose is to give an high-level overview of how to build a custom WebAssembly runtime.
@@ -11,14 +11,14 @@ It is by no means a replacement for runtimes like <a href="https://wasmer.io/">W
1111
Hence, I tried to document it as much as I could!
1212

1313
# How to use❓
14-
Aeon was built with Luna in mind and they travel together so whatever Luna can compile, Aeon can run.
14+
Aeon was built with Luna in mind and they "travel" together so whatever Luna can compile, Aeon can run.
1515
- Pass the Wasm binary compiled by <a href="https://luna-demo.vercel.app/" target="_blank">Luna</a>, the function name and parameters to the main function.
1616
- Done (you should see the result)
1717

1818
(Check the `./example/example.js`)
1919

2020
```js
21-
const startAeonRuntime = require("./runtime/start");
21+
const createAeonRuntime = require("./runtime/start");
2222
// This binary
2323
// - takes 3 parameters of type `i32` (3, 127, 127, 127)
2424
// - outputs one `i32` result (1, 127)
@@ -30,7 +30,8 @@ const n1 = 8;
3030
const n2 = 20;
3131
const n3 = 23;
3232

33-
const result = startAeonRuntime(wasmBinary, "addNumbers", n1, n2, n3);
33+
const runtime = createAeonRuntime(wasmBinary);
34+
const result = runtime("addNumbers", n1, n2, n3);
3435
console.log(`${n1} + ${n2} + ${n3} =`, result) // prints 51
3536
```
3637

0 commit comments

Comments
 (0)