Skip to content

Commit 305cb87

Browse files
Merge pull request #66 from BitGo/BTC-0.deprecation-notice
docs(readme): add deprecation notice
2 parents fe1ca02 + 9ced207 commit 305cb87

File tree

2 files changed

+35
-28
lines changed

2 files changed

+35
-28
lines changed

README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,7 @@
1-
# wasm-miniscript
1+
# Deprecated
22

3-
This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled
4-
to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser.
3+
This repository has migrated to [`BitGoWASM`](https://github.com/BitGo/BitGoWASM).
54

6-
# WebUI playground
5+
The `wasm-miniscript` package has been superseded by the [`wasm-utxo`](https://github.com/BitGo/BitGoWASM/tree/master/packages/wasm-utxo) package.
76

8-
Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action.
9-
10-
# Dependencies
11-
12-
- [Rust](https://www.rust-lang.org/) nightly
13-
- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`)
14-
- [NodeJS](https://nodejs.org/en/)
15-
16-
# Packages
17-
18-
## packages/wasm-miniscript
19-
20-
This contains the core library that is compiled to WebAssembly.
21-
It is a wrapper around the `rust-miniscript` crate.
22-
23-
### Building
24-
25-
If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files:
26-
27-
```bash
28-
cd packages/wasm-miniscript
29-
make -f Container.mk build-image
30-
make -f Container.mk build-wasm
31-
```
7+
The old README is accessible at [README_OLD.md](./README_OLD.md)

README_OLD.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# wasm-miniscript
2+
3+
This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled
4+
to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser.
5+
6+
# WebUI playground
7+
8+
Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action.
9+
10+
# Dependencies
11+
12+
- [Rust](https://www.rust-lang.org/) nightly
13+
- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`)
14+
- [NodeJS](https://nodejs.org/en/)
15+
16+
# Packages
17+
18+
## packages/wasm-miniscript
19+
20+
This contains the core library that is compiled to WebAssembly.
21+
It is a wrapper around the `rust-miniscript` crate.
22+
23+
### Building
24+
25+
If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files:
26+
27+
```bash
28+
cd packages/wasm-miniscript
29+
make -f Container.mk build-image
30+
make -f Container.mk build-wasm
31+
```

0 commit comments

Comments
 (0)