From 0df42153b848d09a129d543b0eeaa73d9380e7e1 Mon Sep 17 00:00:00 2001 From: Atharva Kulkarni Date: Mon, 14 Oct 2024 20:40:51 +0530 Subject: [PATCH] Added version param documentation --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 04fcf5d..63d39c4 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,17 @@ The GitHub action takes the following inputs: - `installMirrorNode`: A boolean parameter that is `false` by default. If set to `true`, the action will install a mirror node in addition to the main node. The mirror node can be accessed at `localhost:8080`. +- `installRelay`: A boolean parameter that is `false` by default. + If set to `true`, the action will install the JSON-RPC-Relay as part of the setup process. This allows you to easily add a relay to your Hedera network setup. The relay is + installed using the `solo relay deploy` command. -| Input | Description | Required | Default | -|----------------|-------------------------------|----------|---------| -| `installRelay` | Install JSON-RPC-Relay | false | false | +| Input | Description | Required | Default | +|----------------|--------------------------------|----------|-----------| +| `installRelay` | Install JSON-RPC-Relay | false | false | +| `hederaVersion`| Hedera network version to use | false | `v0.52.2` | -- `installRelay`: A boolean parameter that is `false` by default. - If set to `true`, the action will install the JSON-RPC-Relay as part of the setup process. This allows you to easily add a relay to your Hedera network setup. The relay is installed using the `solo relay deploy` command. +- `hederaVersion`: An optional parameter to specify the Hedera version used in the setup. + If not provided, the action defaults to the latest Mainnet version (v0.52.2). ## Outputs @@ -45,4 +49,4 @@ The GitHub action outputs the following information: # Tributes This action is based on the work of [Hedera Hashgraph](https://github.com/hashgraph/hedera-services) and [Hedera Solo](https://github.com/hashgraph/solo). -Without the great help of [Timo](https://github.com/timo0), [Nathan](https://github.com/nathanklick), and [Lenin](https://github.com/leninmehedy) this action would not exist. \ No newline at end of file +Without the great help of [Timo](https://github.com/timo0), [Nathan](https://github.com/nathanklick), and [Lenin](https://github.com/leninmehedy) this action would not exist.