11# RxWebSocket
22
3- [ ![ CI Status] ( http ://img.shields.io/travis/ fjcaetano/RxWebSocket.svg?style=flat )] ( https://travis-ci.org/fjcaetano/RxWebSocket )
3+ [ ![ Build Status] ( https ://travis-ci.org/ fjcaetano/RxWebSocket.svg?branch=master )] ( https://travis-ci.org/fjcaetano/RxWebSocket )
44[ ![ Version] ( https://img.shields.io/cocoapods/v/RxWebSocket.svg?style=flat )] ( http://cocoapods.org/pods/RxWebSocket )
55[ ![ License] ( https://img.shields.io/cocoapods/l/RxWebSocket.svg?style=flat )] ( http://cocoapods.org/pods/RxWebSocket )
66[ ![ Platform] ( https://img.shields.io/cocoapods/p/RxWebSocket.svg?style=flat )] ( http://cocoapods.org/pods/RxWebSocket )
77[ ![ codecov] ( https://codecov.io/gh/fjcaetano/RxWebSocket/branch/master/graph/badge.svg )] ( https://codecov.io/gh/fjcaetano/RxWebSocket )
8+ [ ![ Carthage compatible] ( https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat )] ( https://github.com/Carthage/Carthage )
89
910------
1011
@@ -19,7 +20,7 @@ it, simply add the following line to your Podfile:
1920
2021``` ruby
2122pod " RxWebSocket"
22- ```
23+ ```
2324
2425## Usage
2526
@@ -50,6 +51,43 @@ sendButton.rx.tap
5051
5152For further details, check the Example project.
5253
54+ ## Contributing
55+
56+ After cloning the project, pull all submodules with
57+
58+ ``` sh
59+ git submodule update --init --recursive
60+ ```
61+
62+ ### Requirements
63+
64+ RxWebSocket relies on the following for development:
65+
66+ - [ Fastlane] ( https://github.com/fastlane/fastlane )
67+ - [ Autobahn TestSuite] ( https://github.com/crossbario/autobahn-testsuite )
68+ - [ Swiftlint] ( https://github.com/realm/SwiftLint )
69+
70+ To install all dependencies without hassles just run:
71+
72+ ``` sh
73+ ./install_dependencies.sh
74+ ```
75+
76+ Which will install all the dependencies and virtual envs if necessary.
77+
78+ ### Running Tests
79+
80+ Xcode and Fastlane will take care of starting and stopping websocket echoservers
81+ for testing, however if you find that tests are timing out, this is usually a
82+ sign that the server is not running. If so, you can manage it running
83+
84+ ``` sh
85+ ./server.sh [start| stop]
86+ ```
87+
88+ This will tell wstests to launch an echo server on 127.0.0.1:9000. If this port
89+ is unusable for you by any reason, you may change it in the ` server.sh ` file.
90+
5391## License
5492
5593RxWebSocket is available under the MIT license. See the LICENSE file for more info.
0 commit comments