Skip to content

Commit 198fa95

Browse files
xternetfjl
andauthoredSep 2, 2022
README.md: improve grammar (ethereum#25646)
Co-authored-by: Felix Lange <fjl@twurst.com>
1 parent d2027ac commit 198fa95

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed
 

‎README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ directory.
3939
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options. |
4040
| `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. |
4141
| `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. |
42-
| `abigen` | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. |
42+
| `abigen` | Source code generator to convert Ethereum contract definitions into easy-to-use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. |
4343
| `bootnode` | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks. |
4444
| `evm` | Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. `evm --code 60ff60ff --debug run`). |
4545
| `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). |
@@ -65,14 +65,14 @@ Recommended:
6565

6666
* Fast CPU with 4+ cores
6767
* 16GB+ RAM
68-
* High Performance SSD with at least 1TB free space
68+
* High-performance SSD with at least 1TB of free space
6969
* 25+ MBit/sec download Internet service
7070

7171
### Full node on the main Ethereum network
7272

7373
By far the most common scenario is people wanting to simply interact with the Ethereum
7474
network: create accounts; transfer funds; deploy and interact with contracts. For this
75-
particular use-case the user doesn't care about years-old historical data, so we can
75+
particular use case, the user doesn't care about years-old historical data, so we can
7676
sync quickly to the current state of the network. To do so:
7777

7878
```shell
@@ -83,11 +83,11 @@ This command will:
8383
* Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag),
8484
causing it to download more data in exchange for avoiding processing the entire history
8585
of the Ethereum network, which is very CPU intensive.
86-
* Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),
86+
* Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),
8787
(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md)
8888
(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
8989
as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server).
90-
This tool is optional and if you leave it out you can always attach to an already running
90+
This tool is optional and if you leave it out you can always attach it to an already running
9191
`geth` instance with `geth attach`.
9292

9393
### A Full node on the Görli test network
@@ -102,12 +102,12 @@ the main network, but with play-Ether only.
102102
$ geth --goerli console
103103
```
104104

105-
The `console` subcommand has the exact same meaning as above and they are equally
106-
useful on the testnet too. Please, see above for their explanations if you've skipped here.
105+
The `console` subcommand has the same meaning as above and is equally
106+
useful on the testnet too.
107107

108108
Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a bit:
109109

110-
* Instead of connecting the main Ethereum network, the client will connect to the Görli
110+
* Instead of connecting to the main Ethereum network, the client will connect to the Görli
111111
test network, which uses different P2P bootnodes, different network IDs and genesis
112112
states.
113113
* Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth`
@@ -118,9 +118,9 @@ Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a
118118
`geth attach <datadir>/goerli/geth.ipc`. Windows users are not affected by
119119
this.
120120

121-
*Note: Although there are some internal protective measures to prevent transactions from
122-
crossing over between the main network and test network, you should make sure to always
123-
use separate accounts for play-money and real-money. Unless you manually move
121+
*Note: Although some internal protective measures prevent transactions from
122+
crossing over between the main network and test network, you should always
123+
use separate accounts for play and real money. Unless you manually move
124124
accounts, `geth` will by default correctly separate the two networks and will not make any
125125
accounts available between them.*
126126

@@ -155,7 +155,7 @@ configuration file via:
155155
$ geth --config /path/to/your_config.toml
156156
```
157157

158-
To get an idea how the file should look like you can use the `dumpconfig` subcommand to
158+
To get an idea of how the file should look like you can use the `dumpconfig` subcommand to
159159
export your existing configuration:
160160

161161
```shell
@@ -175,7 +175,7 @@ docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \
175175
ethereum/client-go
176176
```
177177

178-
This will start `geth` in snap-sync mode with a DB memory allowance of 1GB just as the
178+
This will start `geth` in snap-sync mode with a DB memory allowance of 1GB, as the
179179
above command does. It will also create a persistent volume in your home directory for
180180
saving your blockchain as well as map the default ports. There is also an `alpine` tag
181181
available for a slim version of the image.
@@ -209,7 +209,7 @@ HTTP based JSON-RPC API options:
209209
* `--ws.addr` WS-RPC server listening interface (default: `localhost`)
210210
* `--ws.port` WS-RPC server listening port (default: `8546`)
211211
* `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`)
212-
* `--ws.origins` Origins from which to accept websockets requests
212+
* `--ws.origins` Origins from which to accept WebSocket requests
213213
* `--ipcdisable` Disable the IPC-RPC server
214214
* `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,txpool,web3`)
215215
* `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it)
@@ -327,7 +327,7 @@ requiring an OpenCL or CUDA enabled `ethminer` instance. For information on such
327327
setup, please consult the [EtherMining subreddit](https://www.reddit.com/r/EtherMining/)
328328
and the [ethminer](https://github.com/ethereum-mining/ethminer) repository.
329329

330-
In a private network setting, however a single CPU miner instance is more than enough for
330+
In a private network setting, however, a single CPU miner instance is more than enough for
331331
practical purposes as it can produce a stable stream of blocks at the correct intervals
332332
without needing heavy resources (consider running on a single thread, no need for multiple
333333
ones either). To start a `geth` instance for mining, run it with all your usual flags, extended
@@ -344,7 +344,7 @@ transactions are accepted at (`--miner.gasprice`).
344344

345345
## Contribution
346346

347-
Thank you for considering to help out with the source code! We welcome contributions
347+
Thank you for considering helping out with the source code! We welcome contributions
348348
from anyone on the internet, and are grateful for even the smallest of fixes!
349349

350350
If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request
@@ -374,6 +374,6 @@ The go-ethereum library (i.e. all code outside of the `cmd` directory) is licens
374374
[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
375375
also included in our repository in the `COPYING.LESSER` file.
376376

377-
The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the
377+
The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the
378378
[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
379379
included in our repository in the `COPYING` file.

0 commit comments

Comments
 (0)
Please sign in to comment.