Skip to content

Commit cfe9a7d

Browse files
committed
update links and usage details
1 parent 5b49d96 commit cfe9a7d

File tree

2 files changed

+41
-39
lines changed

2 files changed

+41
-39
lines changed

Documentation/BUILD_GUIDE.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
## Default web3swift build:
1+
## Build
2+
3+
### Default web3swift build:
24

35
1. Install carthage:
46
```
5-
$ brew install carthage
7+
brew install carthage
68
```
79
2. Run carthage update:
8-
```
9-
$ carthage update --platform iOS
10-
# Available platforms: `iOS, macOS`
10+
```
11+
# Available platforms: `iOS, macOS`
12+
carthage update --platform iOS --use-xcframeworks
1113
```
1214
3. Build project in XCode:
13-
Command + B
15+
`Command + B`
1416

15-
## Build web3swift into .framework:
17+
### Build web3swift into .framework:
1618
```
17-
$ carthage build --no-skip-current --platform iOS
19+
carthage build --no-skip-current --platform iOS
1820
```

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## [Join our discord](https://discord.gg/8tXjHK3pus) if you need a support or want to contribute to web3swift development!
55

6-
![matter-github-swift](https://github.com/matter-labs/web3swift/blob/develop/web3swift-logo.png)
6+
![matter-github-swift](https://github.com/skywinder/web3swift/blob/develop/web3swift-logo.png)
77
[![Build Status](https://travis-ci.com/skywinder/web3swift.svg?branch=develop)](https://travis-ci.com/skywinder/web3swift)
88
[![Swift](https://img.shields.io/badge/Swift-5.4-orange.svg?style=flat)](https://developer.apple.com/swift/)
99
[![Platform](https://img.shields.io/cocoapods/p/web3swift.svg?style=flat)](http://cocoapods.org/pods/web3.swift.pod)
@@ -58,7 +58,7 @@
5858

5959
- [x] **[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) (HD Wallets), [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) (Seed phrases), [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) (Key generation prefixes)**
6060
- [x] **[EIP-20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md)** (Standart interface for tokens - ERC-20), **[EIP-67](https://github.com/ethereum/EIPs/issues/67)** (Standard URI scheme), **[EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md)** (Replay attacks protection)
61-
- [x] **And many others** *(For details about this EIP's look at [Documentation page](https://github.com/matter-labs/web3swift/blob/master/Documentation/))*: EIP-681, EIP-721, EIP-165, EIP-777, EIP-820, EIP-888, EIP-1400, EIP-1410, EIP-1594, EIP-1643, EIP-1644, EIP-1633, EIP-721, EIP-1155, EIP-1376, ST-20
61+
- [x] **And many others** *(For details about this EIP's look at [Documentation page](https://github.com/skywinder/web3swift/blob/master/Documentation/))*: EIP-681, EIP-721, EIP-165, EIP-777, EIP-820, EIP-888, EIP-1400, EIP-1410, EIP-1594, EIP-1643, EIP-1644, EIP-1633, EIP-721, EIP-1155, EIP-1376, ST-20
6262

6363
- [x] 🗜 **Batched requests** in concurrent mode
6464
- [x] **RLP encoding**
@@ -118,7 +118,7 @@ $ open -a Xcode Cartfile
118118
Add the following line to the Cartfile and save it:
119119

120120
```ogdl
121-
github "matter-labs/web3swift" "master"
121+
github "skywinder/web3swift" "master"
122122
```
123123

124124
Run `carthage update` to build the framework. By default, Carthage performs checkouts and creates a new directory 'Carthage' in the same location as your Cartfile. Open this directory, go to 'Build' directory, choose iOS or macOS directory, and use the selected directory framework in your Xcode project.
@@ -218,7 +218,7 @@ let tx = contract.write(
218218
You can see how to our demo project: **WKWebView with injected "web3" provider**:
219219

220220
``` bash
221-
git clone https://github.com/matter-labs/web3swift.git
221+
git clone https://github.com/skywinder/web3swift.git
222222
cd web3swift/Example/web3swiftBrowser
223223
pod install
224224
open ./web3swiftBrowser.xcworkspace
@@ -227,7 +227,7 @@ open ./web3swiftBrowser.xcworkspace
227227
### Build from source
228228

229229
- Clone repo
230-
- Instal dependencies via `./carthage-build.sh --platform iOS` (temp workaround, foe of Carthage bug. [For details please look at](https://github.com/Carthage/Carthage/issues/3019#issuecomment-665136323)
230+
- Install dependencies via `./carthage-build.sh --platform iOS` (temp workaround, foe of Carthage bug. [For details please look at](https://github.com/Carthage/Carthage/issues/3019#issuecomment-665136323)
231231

232232
### Requirements
233233

@@ -241,23 +241,23 @@ open ./web3swiftBrowser.xcworkspace
241241

242242
## Documentation
243243

244-
For full documentation details and FAQ, please look at [Documentation](https://github.com/matter-labs/web3swift/blob/master/Documentation/)
244+
For full documentation details and FAQ, please look at [Documentation](https://github.com/skywinder/web3swift/blob/master/Documentation/)
245245

246-
*If you need to find or understand an API, check [Usage.md](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md).*
246+
*If you need to find or understand an API, check [Usage.md](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md).*
247247

248-
**FAQ moved [Documentation Page](https://github.com/matter-labs/web3swift/blob/master/Documentation/)**
248+
**FAQ moved [Documentation Page](https://github.com/skywinder/web3swift/blob/master/Documentation/)**
249249

250250
Here are quick references for essential features:
251251

252-
- [Preffered models](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#preffered-models)
253-
- [Account Management (create, import, private keys managments, etc.)](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#account-management)
254-
- [Ethereum Endpoints interaction (web3, balance, tx's operations, chain state)](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ethereum-endpoints-interaction)
255-
- [Websockets](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#websockets)
256-
- [ENS](https://github.com/matter-labs/web3swift/blob/master/Documentation/Usage.md#ens)
252+
- [Preffered models](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md#preffered-models)
253+
- [Account Management (create, import, private keys managments, etc.)](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md#account-management)
254+
- [Ethereum Endpoints interaction (web3, balance, tx's operations, chain state)](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md#ethereum-endpoints-interaction)
255+
- [Websockets](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md#websockets)
256+
- [ENS](https://github.com/skywinder/web3swift/blob/master/Documentation/Usage.md#ens)
257257

258258
## Projects that are using web3swift
259259

260-
If you are using this library in your project, please [add a link](https://github.com/matter-labs/web3swift/edit/develop/README.md) to this repo.
260+
If you are using this library in your project, please [add a link](https://github.com/skywinder/web3swift/edit/develop/README.md) to this repo.
261261

262262
* [MyEtherWallet/MEWconnect-iOS](https://github.com/MyEtherWallet/MEWconnect-iOS)
263263
* [Peepeth iOS client](https://github.com/matterinc/PeepethClient)
@@ -274,17 +274,17 @@ If you are using this library in your project, please [add a link](https://githu
274274
* [Biomedical Data Sharing dApp - Geolocation](https://github.com/HD2i/Geolocation-iOS)
275275
* [Alice Wallet](https://github.com/alicedapp/AliceX)
276276
* [web3-react-native](https://github.com/cawfree/web3-react-native)
277-
* [YOUR APP CAN BE THERE (click me)](https://github.com/matter-labs/web3swift/edit/develop/README.md) :wink:
277+
* [YOUR APP CAN BE THERE (click me)](https://github.com/skywinder/web3swift/edit/develop/README.md) :wink:
278278

279279
*Nothing makes developers happier than seeing someone else use our work and go wild with it.*
280280

281281
## Support
282282

283283
**[Join our discord](https://discord.gg/DZKFJFn3) if you need a support or want to contribute to web3swift development!**
284284

285-
- If you **need help**, [open an issue](https://github.com/matter-labs/web3swift/issues).
286-
- If you'd like to **see web3swift best practices**, check [Projects that using web3swift](https://github.com/matter-labs/web3swift#projects-that-using-web3swift).
287-
- If you **found a bug**, [open an issue](https://github.com/matter-labs/web3swift/issues).
285+
- If you **need help**, [open an issue](https://github.com/skywinder/web3swift/issues).
286+
- If you'd like to **see web3swift best practices**, check [Projects that using web3swift](https://github.com/skywinder/web3swift#projects-that-using-web3swift).
287+
- If you **found a bug**, [open an issue](https://github.com/skywinder/web3swift/issues).
288288

289289

290290
## Contribute
@@ -293,47 +293,47 @@ Want to improve? It's awesome:
293293

294294
Then good news for you: **We are ready to pay for your contribution via [@gitcoin bot](https://gitcoin.co/grants/358/web3swift)!**
295295

296-
- If you **have a feature request**, [open an issue](https://github.com/matter-labs/web3swift/issues).
296+
- If you **have a feature request**, [open an issue](https://github.com/skywinder/web3swift/issues).
297297

298-
- If you **want to contribute**, read [contribution policy](https://github.com/matter-labs/web3swift/blob/master/Documentation/CONTRIBUTION_POLICY.md) & [submit a pull request](https://github.com/matter-labs/web3swift/pulls).
298+
- If you **want to contribute**, read [contribution policy](https://github.com/skywinder/web3swift/blob/master/Documentation/CONTRIBUTION_POLICY.md) & [submit a pull request](https://github.com/skywinder/web3swift/pulls).
299299

300300
If you use any of our libraries for work, see if your employers would be interested in donating. Any amount you can donate today to help us reach our goal would be much appreciated.
301301

302-
[Matter Labs](https://github.com/orgs/matter-labs/people) are charged with open-sourсe and do not require money for using their web3swift lib.
302+
[Matter Labs](https://github.com/orgs/skywinder/people) are charged with open-sourсe and do not require money for using their web3swift lib.
303303
We want to continue to do everything we can to move the needle forward.
304304

305305
- **Support us** via [@gitcoin Grant program](https://gitcoin.co/grants/358/web3swift)
306306
- Ether wallet address: `0x6A3738c6299f45c31697aceA647D49EdCC9C28A4`
307307

308-
<img src="https://raw.githubusercontent.com/matter-labs/web3swift/develop/img/Ether-donations.jpeg" width="300" />
308+
<img src="https://raw.githubusercontent.com/skywinder/web3swift/develop/img/Ether-donations.jpeg" width="300" />
309309

310310
### Future steps
311311

312312
You are more than welcome to participate! **Your contribution will be paid via [@gitcoin Grant program](https://gitcoin.co/grants/358/web3swift).**
313313

314+
- [x] Performance Improvements thanks to @**[xdozorx](https://github.com/xdozorx)** for [Update perfomance of import account](https://github.com/skywinder/web3swift/pull/336)
315+
314316
- [ ] **L2 support** (such as [ZkSync](https://zksync.io/))
315317

316318
- [ ] **Modularity** with the basic Web3 subspec/SPM (the most basic functions like transaction signing and interacting with an http rpc server) and other modules with additional functionality
317-
318-
- [ ] Complete Documentation (https://web3swift.github.io/web3swift)
319-
320-
- [ ] Performance Improvements
319+
- [ ] [Complete Documentation](https://web3swift.github.io/web3swift)
321320

322321
- [ ] Convenient methods for namespaces
323322

324323

325324

326325
## Credits
327326

328-
- Alex Vlasov, [@shamatar](https://github.com/shamatar)
329-
- Petr Korolev, [@skywinder](https://github.com/skywinder)
330-
- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh)
327+
- Alex Vlasov, [@shamatar](https://github.com/shamatar) - for the initial implementation
328+
- Petr Korolev, [@skywinder](https://github.com/skywinder) - botstrap and continous support
329+
- Anton Grigorev, [@baldyash](https://github.com/BaldyAsh) - core contributor, who use it and making a lot of ipmprovments
330+
- Yhanks to [web3swift's growing list of contributors](https://github.com/skywinder/web3swift/graphs/contributors).
331331

332332
## Security Disclosure
333333

334-
If you believe you have identified a security vulnerability with web3swift, you should report it as soon as possible via email to [hello@matter-labs.io](mailto:hello@matter-labs.io). Please do not post it to a public issue tracker.
334+
If you believe you have identified a security vulnerability with web3swift, you should report it as soon as possible via email to [web3swift@oxor.io](mailto:web3swift@oxor.io). Please do not post it to a public issue tracker.
335335

336336

337337
## License
338338

339-
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/matter-labs/web3swift/blob/master/LICENSE) for details.
339+
web3swift is available under the Apache License 2.0 license. See the [LICENSE](https://github.com/skywinder/web3swift/blob/master/LICENSE) for details.

0 commit comments

Comments
 (0)