cheykrym/socket.io-client-swift
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme and changelog for new version

Browse Source
This commit is contained in:
Erik Little 2019-01-16 08:51:21 -05:00
parent 4c98c24047
commit 6a3d82c60a
No known key found for this signature in database
GPG Key ID: 62F837E56F4E9320
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -1,6 +1,8 @@
# v14.0.0 # v14.0.0
- Minimum version of the client is now Swift 4.2.
- Add exponential backoff for reconnects, with `reconnectWaitMax` and `randomizationFactor` options [#1149](https://github.com/socketio/socket.io-client-swift/pull/1149) - Add exponential backoff for reconnects, with `reconnectWaitMax` and `randomizationFactor` options [#1149](https://github.com/socketio/socket.io-client-swift/pull/1149)
- `statusChange` event's data format adds a second value, the raw value of the status. This is for use in Objective-C. [#1147](https://github.com/socketio/socket.io-client-swift/issues/1147)
# v13.4.0 # v13.4.0

2
Package.swift
View File

@ -1,4 +1,4 @@
// swift-tools-version:4.0 // swift-tools-version:4.2
import PackageDescription import PackageDescription

10
README.md
View File

@ -63,7 +63,7 @@ SocketIOClient* socket = manager.defaultSocket;
## FAQS ## FAQS
Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions. Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions.
Checkout the [12to13](https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html) guide for migrating to v13. Checkout the [12to13](https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html) guide for migrating to v13+ from v12 below.
## Installation ## Installation
@ -76,7 +76,7 @@ If you need Swift 3.x use v11.1.3.
### Swift Package Manager ### Swift Package Manager
Add the project as a dependency to your Package.swift: Add the project as a dependency to your Package.swift:
```swift ```swift
// swift-tools-version:4.0 // swift-tools-version:4.2
import PackageDescription import PackageDescription
@ -86,7 +86,7 @@ let package = Package(
.executable(name: "socket.io-test", targets: ["YourTargetName"]) .executable(name: "socket.io-test", targets: ["YourTargetName"])
], ],
dependencies: [ dependencies: [
.package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.3.0")) .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "14.0.0"))
], ],
targets: [ targets: [
.target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources") .target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources")
@ -99,7 +99,7 @@ Then import `import SocketIO`.
### Carthage ### Carthage
Add this line to your `Cartfile`: Add this line to your `Cartfile`:
``` ```
github "socketio/socket.io-client-swift" ~> 13.3.0 github "socketio/socket.io-client-swift" ~> 14.0.0
``` ```
Run `carthage update --platform ios,macosx`. Run `carthage update --platform ios,macosx`.
@ -113,7 +113,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
use_frameworks! use_frameworks!
target 'YourApp' do target 'YourApp' do
pod 'Socket.IO-Client-Swift', '~> 13.3.0' pod 'Socket.IO-Client-Swift', '~> 14.0.0'
end end
``` ```