diff --git a/README.md b/README.md index 537620e..4ae53f6 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,7 @@ -# wasm-miniscript +# Deprecated -This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled -to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser. +This repository has migrated to [`BitGoWASM`](https://github.com/BitGo/BitGoWASM). -# WebUI playground +The `wasm-miniscript` package has been superseded by the [`wasm-utxo`](https://github.com/BitGo/BitGoWASM/tree/master/packages/wasm-utxo) package. -Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action. - -# Dependencies - -- [Rust](https://www.rust-lang.org/) nightly -- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`) -- [NodeJS](https://nodejs.org/en/) - -# Packages - -## packages/wasm-miniscript - -This contains the core library that is compiled to WebAssembly. -It is a wrapper around the `rust-miniscript` crate. - -### Building - -If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files: - -```bash -cd packages/wasm-miniscript -make -f Container.mk build-image -make -f Container.mk build-wasm -``` +The old README is accessible at [README_OLD.md](./README_OLD.md) \ No newline at end of file diff --git a/README_OLD.md b/README_OLD.md new file mode 100644 index 0000000..537620e --- /dev/null +++ b/README_OLD.md @@ -0,0 +1,31 @@ +# wasm-miniscript + +This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled +to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser. + +# WebUI playground + +Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action. + +# Dependencies + +- [Rust](https://www.rust-lang.org/) nightly +- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`) +- [NodeJS](https://nodejs.org/en/) + +# Packages + +## packages/wasm-miniscript + +This contains the core library that is compiled to WebAssembly. +It is a wrapper around the `rust-miniscript` crate. + +### Building + +If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files: + +```bash +cd packages/wasm-miniscript +make -f Container.mk build-image +make -f Container.mk build-wasm +```