Skip to content

Commit ca72132

Browse files
authored
Update README.md (Layr-Labs#35)
1 parent c864239 commit ca72132

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ EigenLayer CLI is used to manage core operator functionalities like local key ma
3333

3434

3535
## Install `eigenlayer` CLI using a binary
36-
To download a binary for latest release, run:
36+
To download a binary for the latest release, run:
3737
```bash
3838
curl -sSfL https://raw.githubusercontent.com/layr-labs/eigenlayer-cli/master/scripts/install.sh | sh -s
3939
```
@@ -44,7 +44,7 @@ To add the binary to your path, run:
4444
export PATH=$PATH:~/bin
4545
```
4646

47-
### Installing in custom location
47+
### Installing in a custom location
4848
To download the binary in a custom location, run:
4949
```bash
5050
curl -sSfL https://raw.githubusercontent.com/layr-labs/eigenlayer-cli/master/scripts/install.sh | sh -s -- -b <custom_location>
@@ -119,7 +119,7 @@ eigenlayer operator keys create --key-type bls [keyname]
119119

120120
- `keyname` - This will be the name of the created key file. It will be saved as `<keyname>.ecdsa.key.json` or `<keyname>.bls.key.json`
121121

122-
This will prompt a password which you can use to encrypt the keys. Keys will be stored in local disk and will be shown once keys are created.
122+
This will prompt a password which you can use to encrypt the keys. Keys will be stored in the local disk and will be shown once keys are created.
123123
It will also show the private key only once, so that you can back it up in case you lose the password or keyfile.
124124

125125
Example:
@@ -131,7 +131,7 @@ eigenlayer operator keys create --key-type ecdsa test
131131
```
132132

133133
Output
134-
This outputs the public key and the ethereum address associated with the key. This will also be your operator address.
134+
This outputs the public key and the Ethereum address associated with the key. This will also be your operator address.
135135
```bash
136136
? Enter password to encrypt the ecdsa private key:
137137
ECDSA Private Key (Hex): b3eba201405d5b5f7aaa9adf6bb734dc6c0f448ef64dd39df80ca2d92fca6d7b
@@ -177,7 +177,7 @@ Public Key hex: a30264c19cd7292d5153da9c9df58f81aced417e8587dd339021c45ee61f20d
177177
Ethereum Address 0x9F664973BF656d6077E66973c474cB58eD5E97E1
178178
```
179179

180-
This will prompt a password which you can use to encrypt the keys. Keys will be stored in local disk and will be shown once keys are created.
180+
This will prompt a password which you can use to encrypt the keys. Keys will be stored in the local disk and will be shown once keys are created.
181181
It will also show the private key only once, so that you can back it up in case you lose the password or keyfile.
182182

183183
### List keys
@@ -213,14 +213,14 @@ You can create the config files needed for operator registration using the below
213213
eigenlayer operator config create
214214
```
215215

216-
It will create two file: `operator.yaml` and `metadata.json`
217-
After filling the details in `metadata.json`, please upload this into a publicly accessible location and fill that url in `operator.yaml`.
218-
A valid metadata url is required for successful registration.
216+
It will create two files: `operator.yaml` and `metadata.json`
217+
After filling in the details in `metadata.json`, please upload this into a publicly accessible location and fill that URL in `operator.yaml`.
218+
A valid metadata URL is required for successful registration.
219219
A sample yaml [operator.yaml](pkg/operator/config/operator-config-example.yaml) is provided for reference.
220220

221-
A public metadata url is required to register the operator.
222-
After creating and filling the [metadata](pkg/operator/config/metadata-example.json) file, you can it to a publicly accessible location and give the url in the config file.
223-
You are also required to upload the image of the operator to a publicly accessible location and give the url in the metadata file. We only support `.png` images for now.
221+
A public metadata URL is required to register the operator.
222+
After creating and filling the [metadata](pkg/operator/config/metadata-example.json) file, you can it to a publicly accessible location and give the URL in the config file.
223+
You are also required to upload the image of the operator to a publicly accessible location and give the URL in the metadata file. We only support `.png` images for now.
224224

225225

226226
### Registration
@@ -233,7 +233,7 @@ You can register your operator using the command below.
233233
eigenlayer operator register operator.yaml
234234
```
235235

236-
Make sure that if you use `local_keystore` as signer, you give the path to the keys created in above section.
236+
Make sure that if you use `local_keystore` as the signer, you give the path to the keys created in the above section.
237237

238238
After you complete the registration, you can check the registration status of your operator using
239239

0 commit comments

Comments
 (0)