Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Smorci authored Sep 6, 2024
1 parent 89eb6cd commit fd5cce6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# ethereum-node-automation
Automated solution to setup a local network of at least three ethereum nodes
Simple to use, packaged, continuously deployed solution to start 3 monitored ethereum nodes in your local environment

## Pre-requisite
1.Nix version 2.18.2 or higher. Follow the [installation instructions](https://nix.dev/install-nix.html) for your operating system.
2. Github personal access token. Follow the [official documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) or take a look at the detailed application specific documentation in this repository.

## `.env` file

Create a `.env` file in the repository root, adding your github access token
```
export GITHUB_TOKEN=<your-github-access-token>
```
> Replace `<your-github-access-token>` with the generated access token in *pre-requisite* section
## Usage

```
kind create cluster --name ethereum-nodes
Expand Down

0 comments on commit fd5cce6

Please sign in to comment.