Skip to content

Commit 434fe24

Browse files
committed
docs: updated docs
1 parent 1b8f74d commit 434fe24

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
# Aeon ⏳✨
22

3-
Aeon is an extremely tiny and easy to use WebAssembly Binary Format runtime for <a href="https://github.com/thomscoder/luna" target="_blank">Luna</a>, built for demonstration and educational purposes.
3+
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.
45

5-
It is part of the <a href="https://github.com/thomscoder/luna" target="_blank">Luna</a> project, so its purpose is to give an overview of how to build a custom WebAssembly runtime.
6+
It is part of the <a href="https://github.com/thomscoder/luna" target="_blank">Luna</a> project, so they integrate very very well.
7+
Its purpose is to give an high-level overview of how to build a custom WebAssembly runtime.
68

7-
It is not a replacement for solid runtimes like <a href="https://wasmer.io/">Wasmer</a> or <a href="https://github.com/bytecodealliance/wasmtime">Wasmtime</a>, it is just a tool that should serve as a landmark for anyone that wants to start learning the secrets of Wasm.
9+
It is by no means a replacement for runtimes like <a href="https://wasmer.io/">Wasmer</a> or <a href="https://github.com/bytecodealliance/wasmtime">Wasmtime</a>, it is just a tool that aims to serve as a `landmark` for anyone that wants to start learning Wasm.
810

911
Hence, I tried to document it as much as I could!
1012

1113
# How to use❓
12-
- Pass the Wasm binary, the function name and parameters to the main function
14+
Aeon was built with Luna in mind and they travel together so whatever Luna can compile, Aeon can run.
15+
- 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.
1316
- Done (you should see the result)
1417

18+
(Check the `./example/example.js`)
19+
1520
```js
1621
const startAeonRuntime = require("./runtime/start");
1722
// This binary
@@ -34,6 +39,9 @@ console.log(`${n1} + ${n2} + ${n3} =`, result) // prints 51
3439
- `Support more wasm feature` currently it supports only additions and i32 integers, but it makes it easy to add more features
3540

3641
# Contribute
42+
Both Aeon and Luna are infants.
43+
There are tons and tons of feature they could implement. I try to keep them as much basic as possible as they should serve as a learning playground rather than making competition to other tools.
44+
3745
If you have any suggestion, feedback or want to add features, feel free to open issues, pull requests or fork the project.
3846
Turn it into a npm package, embed it in your next project, build beautiful tutorials...
3947
Aeon will be able (in the near future) to be open to all the possibilities to teach Web Assembly.

example/main.wat

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
;; Module that exports a function called "aeonAddition"
2-
;; Compile this with https://luna-demo.vercel.app
31
(module
42
(func (export "aeonAddition") (param i32 i32) (result i32)
53
local.get 0

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
"description": "",
55
"main": "index.js",
66
"scripts": {
7-
"test": "echo \"Error: no test specified\" && exit 1"
7+
"test": "echo \"Error: no test specified\" && exit 1",
8+
"start": "node index.js",
9+
"start:example": "node ./example/example.js"
810
},
911
"keywords": [],
1012
"author": "",

0 commit comments

Comments
 (0)