Skip to content

Commit 44683b4

Browse files
authored
Update README.md
1 parent 2e00373 commit 44683b4

File tree

1 file changed

+2
-23
lines changed

1 file changed

+2
-23
lines changed

README.md

+2-23
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,6 @@ The root crate is a workspace for various Sapio Components such as:
1818
1. [Sapio Front](sapio-front/): Protocols for interacting with a compilation session
1919
1. [Sapio Compiler Server](sapio-ws/): Binary for a websocket server running sapio-front
2020

21-
## QuickStart:
21+
## Getting Started
2222

23-
Sapio should work on all platforms, but is recommended for use with Linux (Ubuntu preferred).
24-
Follow this quickstart guide to get going.
25-
26-
1. Get [rust](https://rustup.rs/) if you don't have it already.
27-
1. Add the wasm target by running `rustup target add wasm32-unknown-unknown` in your terminal.
28-
1. Get the [wasm-pack](https://rustwasm.github.io/wasm-pack/) tool.
29-
1. Clone this repo: `git clone [email protected]:sapio-lang/sapio.git && cd sapio`
30-
1. Build the plugin `cd plugin-example && wasm-pack build && cd ..`
31-
1. Instantiate a contract from the plugin: `cargo run --bin sapio-cli -- contract create 9.99 "{\"participants\": [{\"amount\": 9.99, \"address\": \"bcrt1qs758ursh4q9z627kt3pp5yysm78ddny6txaqgw\"}], \"radix\": 2, \"fee_sats_per_tx\": "0"}" --file="plugin-example/pkg/sapio_wasm_plugin_example_bg.wasm"` to see some magic!
32-
33-
You can use `cargo run --bin sapio-cli -- help` to learn more about what the CLI can do! and `cargo run --bin sapio-cli -- <subcommand> help` to learn about subcommands like `contract`.
34-
35-
As a second experiment, try modifying the contract in plugin-example to one
36-
of the contracts from sapio-contrib! Remember to recompile plugin-example
37-
with `wasm-pack build`!
38-
39-
Still hungry for more? Implement your own smart contract idea -- you can use
40-
sapio-contrib for inspiration or as building blocks for something new!
41-
42-
Stuck? Run `cargo doc --open --no-deps` to build and open the documentation
43-
locally, or just shoot me a note and I'll guide you through it! Any and all
44-
feedback welcome!
23+
Please see the [Designing Bitcoin Contracts with Sapio](https://learn.sapio-lang.org) book to get going!

0 commit comments

Comments
 (0)