Skip to content

Commit

Permalink
Added version param documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Atharva1723 authored Oct 14, 2024
1 parent 9fc531a commit 0df4215
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
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.

0 comments on commit 0df4215

Please # to comment.