From 3f5a879511ee70a5fdffd65ee8d4f89443f052bd Mon Sep 17 00:00:00 2001 From: Collin Chin Date: Fri, 17 Feb 2023 21:14:09 -0500 Subject: [PATCH] commit readme updates --- sdk/README.md | 2 +- wasm/PUBLISH.md | 10 ++++++++++ wasm/README.md | 25 ++++++++++++++++++++----- 3 files changed, 31 insertions(+), 6 deletions(-) create mode 100644 wasm/PUBLISH.md diff --git a/sdk/README.md b/sdk/README.md index c81a7bff1..9ba365e9c 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -23,6 +23,6 @@ Happy hacking! [Aleo SDK account generator](https://aleohq.github.io/aleo/) -[Aleo web](https://www.aleo.org/) +[Aleo Home](https://www.aleo.org/) You can visit the [SnarkVM repo](https://github.com/AleoHQ/snarkVM) and [SnarkOS repo](https://github.com/AleoHQ/snarkOS) to go deep into the code of aleo infrastructure diff --git a/wasm/PUBLISH.md b/wasm/PUBLISH.md new file mode 100644 index 000000000..789e28739 --- /dev/null +++ b/wasm/PUBLISH.md @@ -0,0 +1,10 @@ +# Aleo Wasm + +## Publish instructions + +```bash +npm login +wasm-pack build --scope aleohq +cd pkg +npm publish --access=public +``` diff --git a/wasm/README.md b/wasm/README.md index 789e28739..c1d07099d 100644 --- a/wasm/README.md +++ b/wasm/README.md @@ -1,10 +1,25 @@ # Aleo Wasm -## Publish instructions +Aleo low-level utilities for account and record management in Rust - packaged to be Wasm-compatible. +For more general utilities to help with program compilation and node connectivity, check out https://crates.io/crates/aleo. + +Happy hacking! + +## Build Guide +```bash +wasm-pack build --target nodejs +``` + +## Testing ```bash -npm login -wasm-pack build --scope aleohq -cd pkg -npm publish --access=public +wasm-pack test ``` + +## Aleo Tools + +[Aleo SDK account generator](https://aleohq.github.io/aleo/) + +[Aleo Home](https://www.aleo.org/) + +You can visit the [SnarkVM repo](https://github.com/AleoHQ/snarkVM) and [SnarkOS repo](https://github.com/AleoHQ/snarkOS) to go deep into the code of aleo infrastructure