Skip to content

Commit f7e008c

Browse files
committed
update readme
1 parent b1228e0 commit f7e008c

2 files changed

Lines changed: 31 additions & 6 deletions

File tree

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,36 @@ Most of the APIs are the same as socket.io-client-java, here are some difference
6060

6161
## Development
6262

63+
You can open this project in Android Studio, but please setup iOS example project first:
64+
65+
```bash
66+
brew install cocoapods xcodegen
67+
# if you have installed them earlier, you need to remove them at first,
68+
# or run brew link --overwrite xcodegen cocoapods
69+
70+
cd example/iosApp
71+
xcodegen
72+
pod install
73+
```
74+
75+
Otherwise you may see error like below:
76+
77+
```bash
78+
> Task :example:shared:podInstall FAILED
79+
80+
FAILURE: Build failed with an exception.
81+
82+
* What went wrong:
83+
Execution failed for task ':example:shared:podInstall'.
84+
> 'pod install' command failed with code 1.
85+
Error message:
86+
87+
Please, check that podfile contains following lines in header:
88+
source 'https://cdn.cocoapods.org'
89+
90+
Please, check that each target depended on shared contains following dependencies:
91+
```
92+
6393
To check coverage details, run `./gradlew :kmp-socketio:jvmTest --info && ./gradlew koverHtmlReport`,
6494
then check `kmp-socketio/build/reports/kover/html/index.html`.
6595

@@ -75,12 +105,7 @@ Open the project (the repo root dir) in Android studio, and run the example.andr
75105
### iOS
76106

77107
```bash
78-
brew install cocoapods xcodegen
79-
# if you have installed them earlier, you need to remove them at first,
80-
# or run brew link --overwrite xcodegen cocoapods
81-
82108
cd example/iosApp
83-
xcodegen
84109
pod install
85110
# open iosApp.xcworkspace in Xcode, and run it.
86111
```

kmp-socketio/src/jvmTest/kotlin/com/piasy/kmp/socketio/engineio/transports/PollingXHRTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ class PollingXHRTest : BaseTest() {
257257
// initial poll, then write close packet, and state will be set to OPEN in onOpen,
258258
// then it will poll again in onPollComplete
259259
coVerify(exactly = 3) { polling.factory.httpRequest(any(), any()) }
260-
Logging.info("XXPXX", "closeOpening verify events")
260+
Logging.info("XXPXX", "closeOpening verify events, ${polling.events.size} events")
261261
// sometimes the mock response of close packet can't be retrieved...
262262
if (polling.events.size == 9) {
263263
assertEquals(

0 commit comments

Comments
 (0)