Skip to content

Commit 67b3232

Browse files
authored
Fix readme, remove outdated references
1 parent 6880d0a commit 67b3232

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
![bkx-foundation-github-swift](https://user-images.githubusercontent.com/3356474/34412791-5b58962c-ebf0-11e7-8460-5592b12e6e9d.png)
2-
31
<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)
42
## Important notices
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.
6-
7-
Example is updated for 0.5.0, although please prefer to use tests as an example for your code.
3+
The work for 2.0 release is about to start. Ideas for new more Swift idiomatic API are welcome in issues.
84

95
# web3swift
106

@@ -76,15 +72,15 @@ You can try it yourself by running the example project:
7672

7773
## Requirements
7874

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.
75+
Web3swift requires Swift 4.1 and iOS 9.0 or macOS 10.11 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.
8076

8177
## Communication
8278

8379
- if you **need help**, use [Stack Overflow](https://stackoverflow.com/questions/tagged/web3swift) (tag 'web3swift')
8480
- If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/web3swift).
85-
- If you **found a bug**, [open an issue](https://github.com/BANKEX/web3swift/issues).
86-
- If you **have a feature request**, [open an issue](https://github.com/BANKEX/web3swift/issues).
87-
- If you **want to contribute**, [submit a pull request](https://github.com/BANKEX/web3swift/pulls).
81+
- If you **found a bug**, [open an issue](https://github.com/matterinc/web3swift/issues).
82+
- If you **have a feature request**, [open an issue](https://github.com/matterinc/web3swift/issues).
83+
- If you **want to contribute**, [submit a pull request](https://github.com/matterinc/web3swift/pulls).
8884

8985
## Installation
9086

@@ -106,7 +102,7 @@ platform :ios, '9.0'
106102

107103
target '<Your Target Name>' do
108104
use_frameworks!
109-
pod 'web3swift', '~> 0.8.0'
105+
pod 'web3swift', '~> 1.1.5'
110106
end
111107
```
112108

@@ -204,11 +200,11 @@ switch convenienceTransferResult {
204200
- Full reference `web3js` functionality
205201
- Light Ethereum subprotocol (LES) integration
206202
207-
## [Apps using this library](https://github.com/BANKEX/web3swift/wiki/Apps-using-web3swift)
203+
## [Apps using this library](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift)
208204
209205
If you've used this project in a live app, please let us know!
210206
211-
*If you are using `web3swift` in your app or know of an app that uses it, please add it to [this](https://github.com/BANKEX/web3swift/wiki/Apps-using-web3swift) list.*
207+
*If you are using `web3swift` in your app or know of an app that uses it, please add it to [this](https://github.com/matterinc/web3swift/wiki/Apps-using-web3swift) list.*
212208
213209
## Special thanks to
214210
@@ -218,24 +214,24 @@ If you've used this project in a live app, please let us know!
218214
219215
## Contribution
220216
221-
For the latest version, please check [develop](https://github.com/BANKEX/web3swift/tree/develop) branch.
222-
Changes made to this branch will be merged into the [master](https://github.com/BANKEX/web3swift/tree/master) branch at some point.
217+
For the latest version, please check [develop](https://github.com/matterinc/web3swift/tree/develop) branch.
218+
Changes made to this branch will be merged into the [master](https://github.com/matterinc/web3swift/tree/master) branch at some point.
223219
224-
- If you want to contribute, submit a [pull request](https://github.com/BANKEX/web3swift/pulls) against a development `develop` branch.
225-
- If you found a bug, [open an issue](https://github.com/BANKEX/web3swift/issues).
226-
- If you have a feature request, [open an issue](https://github.com/BANKEX/web3swift/issues).
220+
- If you want to contribute, submit a [pull request](https://github.com/matterinc/web3swift/pulls) against a development `develop` branch.
221+
- If you found a bug, [open an issue](https://github.com/matterinc/web3swift/issues).
222+
- If you have a feature request, [open an issue](https://github.com/matterinc/web3swift/issues).
227223
228224
229225
## Appreciation
230226
231-
When using this pod, references to this repo, [BANKEX](http://bankex.com) and [BANKEX Foundation](http://bankexfoundation.org) are appreciated.
227+
When using this pod, please make references to this repo and give your start! :)
232228
233229
## Authors
234230
235-
Alex Vlasov, [@shamatar](https://github.com/shamatar), [email protected]
231+
Alex Vlasov, [@shamatar](https://github.com/shamatar), [email protected]
236232
237-
Petr Korolev, [@skywinder](https://github.com/skywinder), [email protected]
233+
Petr Korolev, [@skywinder](https://github.com/skywinder)
238234
239235
## License
240236
241-
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/BankEx/web3swift/blob/master/LICENSE) file for more info.
237+
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/matterinc/web3swift/blob/master/LICENSE) file for more info.

0 commit comments

Comments
 (0)