Skip to content

Commit

Permalink
Merge pull request #109 from NillionNetwork/docs/automatic-nilup-initing
Browse files Browse the repository at this point in the history
docs: Adapt installation docs to new `install.sh` behavior
  • Loading branch information
jwolski2 authored Oct 10, 2024
2 parents 2d91fbd + c662d85 commit 979a732
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 20 deletions.
23 changes: 4 additions & 19 deletions docs/_sdk-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -33,12 +27,3 @@ For more information, check out our [privacy policy](https://nillion.com/privacy
```bash
nilup instrumentation enable --wallet <your-eth-wallet-address>
```

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
```
4 changes: 3 additions & 1 deletion docs/nada-by-example-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 979a732

Please sign in to comment.