Skip to content

Commit dfb715b

Browse files
committed
docs: fix grammar and improve phrasing in README
- Fixed grammatical errors - Improved sentence structure and clarity - Enhanced readability of usage examples 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
1 parent 83cc8ad commit dfb715b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
This small Ruby [gem](https://rubygems.org/gems/erc20)
1515
makes manipulations with [Ethereum] [ERC20] tokens
16-
as simple as they can be, if you have a provider of
17-
[JSON-RPC] and [WebSockets] Ethereum APIs, for example
16+
as simple as possible, when you have a provider of
17+
[JSON-RPC] and [WebSockets] Ethereum APIs, such as
1818
[Infura], [GetBlock], or [Alchemy]:
1919

2020
```ruby
@@ -44,10 +44,10 @@ w.accept(addresses) do |event|
4444
end
4545
```
4646

47-
It's also possible to check ETH balance and send ETH transaction:
47+
You can also check ETH balance and send ETH transactions:
4848

4949
```ruby
50-
# Check how many ETHs are there on the given address:
50+
# Check how many ETHs are on the given address:
5151
eth = w.eth_balance(address)
5252

5353
# Send a few ETHs to someone and get transaction hash:
@@ -110,13 +110,13 @@ Then, run it:
110110
erc20 --help
111111
```
112112

113-
It should be obvious how to use it. If not, please, submit an issue.
113+
Usage should be straightforward. If you have questions, please submit an issue.
114114

115115
## How to use in tests
116116

117-
You can use `ERC20::FakeWallet` class that behaves exactly like
117+
You can use the `ERC20::FakeWallet` class that behaves exactly like
118118
`ERC20::Wallet`, but doesn't make any network connections to the provider.
119-
Also, it remembers all requests that were sent to it:
119+
Additionally, it records all requests sent to it:
120120

121121
```ruby
122122
require 'erc20'
@@ -129,7 +129,7 @@ assert w.history.include?({ method: :pay, priv:, address:, amount: 42_000 })
129129

130130
Read
131131
[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
132-
Make sure you build is green before you contribute
132+
Make sure your build is green before you contribute
133133
your pull request. You will need to have
134134
[Ruby](https://www.ruby-lang.org/en/) 3.2+ and
135135
[Bundler](https://bundler.io/) installed. Then:

0 commit comments

Comments
 (0)