Skip to content

Commit aa380b9

Browse files
authored
Merge pull request #304 from availproject/staging
Minor streamlining of light client API reference
2 parents 44e3205 + d0cb07b commit aa380b9

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

pages/docs/operate-a-node/run-a-light-client/light-client-api-reference.mdx

+32-3
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,37 @@ This will be documented in the individual method descriptions.
2828
2. It is recommended to use `API-v2` over `API-v1`, although both are supported.
2929
3. The methods documented here were tested on a locally running instance of the Avail light client.
3030
They will however work with remotely hosted instances as well.
31+
4. You can check out or docs for [instructions on running your own instance
32+
of the Avail light client](/docs/operate-a-node/run-a-light-client/0010-light-client)
3133
</Callout>
3234

33-
<Callout type="info">
34-
How to run the Rust code snippets
35+
## Setting up the dev environment
36+
37+
Set up your dev enviornment with `curl` and `Rust`:
38+
39+
<Tabs items={['CURL', 'Rust']}>
40+
41+
<Tabs.Tab>
42+
43+
1. To use the Avail light client API with `curl`, you just need to have `curl` installed on your system.
44+
You can check if it is installed by running:
45+
46+
```sh
47+
curl --version
48+
```
49+
50+
2. If this does not work, go to [curl's website](https://curl.se/) to install it on your system.
51+
</Tabs.Tab>
52+
53+
<Tabs.Tab>
54+
How to run the Rust code snippets:
55+
56+
1. Make sure you have [Rust](https://www.rust-lang.org) and [Cargo](https://crates.io/) installed on your system before moving forward. You can check that by running:
57+
```sh
58+
rustc --version && cargo --version
59+
```
60+
If either of these don't work, you can check out [Rust's official installation guide](https://www.rust-lang.org/tools/install).
61+
3562

3663
1. Create a new Rust project:
3764
```sh
@@ -47,7 +74,9 @@ How to run the Rust code snippets
4774
base64 = "0.22"
4875
```
4976
3. Paste the code snippets into the `main.rs` file, and run the project with `cargo run`.
50-
</Callout>
77+
78+
</Tabs.Tab>
79+
</Tabs>
5180

5281
## API-v1
5382

0 commit comments

Comments
 (0)