Skip to content

Commit 64592e3

Browse files
authored
Update README.md
1 parent 984cf79 commit 64592e3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<img align="left" width="25" height="25" src="https://user-images.githubusercontent.com/28599454/41086111-af4bc3b0-6a41-11e8-9f9f-2d642b12666e.png">[Ask questions](https://stackoverflow.com/questions/tagged/web3swift)
44
## Important notices
5-
With the version 0.3.0 API should be less volatile. All public functions should return a [Result](https://github.com/antitypical/Result) instead of `nil` or throwing.
5+
With the version 0.3.0 the API should be less volatile. All public functions should return a [Result](https://github.com/antitypical/Result) instead of `nil` or throwing.
66

77
Example is updated for 0.5.0, although please prefer to use tests as an example for your code.
88

@@ -20,7 +20,7 @@ Example is updated for 0.5.0, although please prefer to use tests as an example
2020
- RLP encoding
2121
- Interactions (read/write to Smart contracts) :arrows_counterclockwise:
2222
- Local keystore management (geth compatible)
23-
- Literally following the standarts:
23+
- Literally following the standards:
2424
- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) HD Wallets: Deterministic Wallet
2525
- [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases)
2626
- [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)
@@ -29,18 +29,18 @@ Example is updated for 0.5.0, although please prefer to use tests as an example
2929

3030
## Check this out
3131

32-
- Private key and transaction were created directly on the iOS device and sent directly to [Infura](https://infura.io) node
32+
- Private key and transaction were created directly on an iOS device and sent directly to [Infura](https://infura.io) node
3333
- Native API
34-
- Security (as cool as hard wallet! Right out-of-the-box! :box: )
35-
- No unnecessary dependencies
34+
- Security (as cool as a hard wallet! Right out-of-the-box! :box: )
35+
- No unnecessary dependencies
3636
- Possibility to work with all existing smart contracts
3737
- Referencing the newest features introduced in Solidity
3838

3939
## Design decisions
4040

41-
- Not every JSON RPC function is exposed yet, priority is gives to ones required for mobile devices
42-
- Functionality was focused on serializing and signing transactions locally on device to send raw transaction to Ethereum network
43-
- Requirements for password input on every transactions are indeed a design decision. Interface designers can save user passwords given user's consent
41+
- Not every JSON RPC function is exposed yet, priority is given to the ones required for mobile devices
42+
- Functionality was focused on serializing and signing transactions locally on the device to send raw transactions to Ethereum network
43+
- Requirements for password input on every transaction are indeed a design decision. Interface designers can save user passwords with the user's consent
4444
- Public function for private key export is exposed for user convenience, but marked as UNSAFE_ :) Normal workflow takes care of EIP155 compatibility and proper clearing of private key data from memory
4545

4646
### Here it is
@@ -67,7 +67,7 @@ On Rinkeby TXid = 0xc6eca60ecac004a1501a4323a10edb7fa4cd1a0896675f6b51704c84deda
6767

6868
## Example
6969

70-
You can try it by yourself by running the example project:
70+
You can try it yourself by running the example project:
7171

7272
- Clone the repo
7373
- `cd Example/web3swiftExample`
@@ -76,7 +76,7 @@ You can try it by yourself by running the example project:
7676

7777
## Requirements
7878

79-
Web3swift requires Swift 4.1 and iOS 9.0 or macOS 10.13 although we recommend to use the latest iOS and MacOS versions for your own safety. Don't forget to set iOS version in a Podfile, otherwise you get an error if deployment target is less than the latest SDK.
79+
Web3swift requires Swift 4.1 and iOS 9.0 or macOS 10.13 although we recommend to use the latest iOS and MacOS versions for your own safety. Don't forget to set the iOS version in a Podfile, otherwise you get an error if the deployment target is less than the latest SDK.
8080

8181
## Communication
8282

@@ -119,7 +119,7 @@ $ pod install
119119

120120
- [x] Create Account
121121
- [x] Import Account
122-
- [x] Sign transictions
122+
- [x] Sign transactions
123123
- [x] Send transactions, call functions of smart-contracts, estimate gas costs
124124
- [x] Serialize and deserialize transactions and results to native Swift types
125125
- [x] Convenience functions for chain state: block number, gas price
@@ -130,7 +130,7 @@ $ pod install
130130

131131
## Usage
132132

133-
Here you can see a few examples of use of our library
133+
Here's a few use cases of our library
134134
### Initializing Ethereum address
135135
```bash
136136
let coldWalletAddress = EthereumAddress("0x6394b37Cf80A7358b38068f0CA4760ad49983a1B")
@@ -213,7 +213,7 @@ If you've used this project in a live app, please let us know!
213213
## Special thanks to
214214
215215
- Gnosis team and their library [Bivrost-swift](https://github.com/gnosis/bivrost-swift) for inspiration for the ABI decoding approach
216-
- [Trust iOS Wallet](https://github.com/TrustWallet/trust-wallet-ios) for collaboration and discussion for initial idea
216+
- [Trust iOS Wallet](https://github.com/TrustWallet/trust-wallet-ios) for the collaboration and discussion of the initial idea
217217
- Official Ethereum and Solidity docs, everything was written from ground truth standards
218218
219219
## Contribution

0 commit comments

Comments
 (0)