From bbb083091c41bc709cebec56af4176c9eb15afb2 Mon Sep 17 00:00:00 2001 From: Jeff Wolski Date: Thu, 10 Oct 2024 09:31:46 +0200 Subject: [PATCH 1/2] docs: Adapt installation docs to new `install.sh` behavior The nilup `install.sh` script has been modified to automatically run `nilup init` which means users no longer have to run it or `nilup install latest` themselves. This commit updates the docs to reflect the new behavior and expectations. --- docs/_sdk-installation.mdx | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/docs/_sdk-installation.mdx b/docs/_sdk-installation.mdx index d88606e..c30f3cc 100644 --- a/docs/_sdk-installation.mdx +++ b/docs/_sdk-installation.mdx @@ -10,21 +10,15 @@ it works, before piping it to `bash`._ curl https://nilup.nilogy.xyz/install.sh | bash ``` -Close your terminal. Open a new terminal and confirm global `nilup` tool installation +The install script installs `nilup` and the latest version of the SDK. Close your terminal. Open a +new terminal and confirm both `nilup` and `nillion` are installed: ```bash -nilup -V +nilup -V; nillion -V // Your output should be similar to the below nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4 -``` - -#### 2. Use [nilup](/nilup) to install the latest version of the Nillion SDK. - -```bash -nilup install latest -nilup use latest -nilup init +tools-config 22c84830fff3c86beec27a8cb6353d45e7bfb8a4 ``` Optionally enable `nilup` telemetry, providing your Ethereum wallet address. We collect this data to understand how the software is used, and to better assist you in case of issues. In doing this, you consent to the collection of telemetry data by the Nillion Network. While we will not collect any personal information, we still recommend using a new wallet address that cannot be linked to your identity by any third party. @@ -33,12 +27,3 @@ For more information, check out our [privacy policy](https://nillion.com/privacy ```bash nilup instrumentation enable --wallet ``` - -Close your terminal. Open a new terminal and confirm global Nillion tool installation with - -```bash -nillion -V - -// Your output should be similar to the below -nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4 -``` From c662d8559b36a7cc8037ba01c645ae2ae5a4f07e Mon Sep 17 00:00:00 2001 From: Jeff Wolski Date: Thu, 10 Oct 2024 09:35:28 +0200 Subject: [PATCH 2/2] docs: Update nada quickstart to reflect new nilup `install.sh` behavior --- docs/nada-by-example-quickstart.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/nada-by-example-quickstart.md b/docs/nada-by-example-quickstart.md index d034cc4..1b5c15f 100644 --- a/docs/nada-by-example-quickstart.md +++ b/docs/nada-by-example-quickstart.md @@ -49,7 +49,9 @@ curl https://nilup.nilogy.xyz/install.sh | bash #### 2. Use the latest version of the Nillion SDK -Install and use the `latest` version of the Nillion SDK and tools. +If you ran the `install.sh` script above, then it installed `nilup` and the latest version of the +SDK for you. If you did not, then install and use the `latest` version of the Nillion SDK and tools +by running: ``` nilup install latest