Skip to content

Commit 284bcad

Browse files
committed
feat: improve readme
1 parent a7d98b0 commit 284bcad

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,44 @@ You can pass additional flags to the script like:
1111
```bash
1212
curl -sL1 avail.sh | bash -s -- --network goldberg
1313
```
14+
1415
Currently available flags are:
1516
* `network`: can be one of the following: [`goldberg`, `local`]
1617
* `config`: path to the configuration file, availup will generate a config if this flag is not specified
18+
* This flag is always required when running a local testnet
1719
* `identity`: path to the identity file, availup will generate a config if this flag is not specified
20+
* It is important to keep your identity file safe!
1821
* `app_id`: application ID to run the light client (defaults to `0`)
22+
* It is recommended to not change this flag unless you require the app-specific mode.
1923
* `upgrade`: takes `y` and `yes` as valid arguments, indicating that the `avail-light` binary should be upgraded
24+
* Using this flag wipes your existing data and config, use with caution!
2025

21-
You can modify the existing default config by running and rerun `availup` to use the new config:
26+
You can use a custom config by passing it to `availup` as a flag:
2227
```bash
2328
# create the config:
24-
touch ~/.avail/config/config.yml
29+
touch ~/config.yml
2530
# edit the config:
26-
nano ~/.avail/config/config.yml
31+
nano ~/config.yml
2732
# and rerunning the script:
28-
curl -sL1 avail.sh | bash -s -- --config ~/.avail/config/config.yml
33+
curl -sL1 avail.sh | bash -s -- --config ~/config.yml
2934
```
3035

36+
> ⚠️ It is not recommended to modify the default config stored in `~/.avail/config/config.yml` as that gets wiped on
37+
> each run.
38+
3139
Alternatively, you can pass a specific application ID with `availup`:
3240
```bash
3341
rm ~/.avail/goldberg/config.yml
3442
# and rerunning the script with flags:
3543
curl -sL1 avail.sh | bash -s -- --app_id 1
3644
```
3745

38-
To upgrade the light client to a latest version, you can simply pass the `--upgrade` flag like:
46+
> ℹ️ Adding an app ID disables the LC mode and runs your client in an app-specific mode, this might not be your
47+
> intention.
48+
49+
To upgrade the light client to the latest supported version, you can simply pass the `--upgrade` flag like:
3950
```bash
4051
curl -sL1 avail.sh | bash -s -- --upgrade y
4152
```
53+
54+
> ℹ️ Upgrading the LC only works if the binary was installed with the latest `availup` script or cargo.

0 commit comments

Comments
 (0)