Permalink
Browse files

Update.

  • Loading branch information...
1 parent 30d5f0f commit 5c2aa26f6db944d33925985b14f6574f6f0acb45 @pk committed Apr 22, 2012
Showing with 23 additions and 10 deletions.
  1. +23 −10 README.md
View
@@ -15,18 +15,18 @@ environments.
I follow the terms in the specification to divide project in to the three layers.
-1) High-level public API defined in the PKWebSocket. At this layer you work with
+1. High-level public API defined in the PKWebSocket. At this layer you work with
the messages which you send and receive. PKWebSocketMessage is an envelope object
to be possible add binary messages for the RFC6455 version of the protocol.
All API at this layer is **PUBLIC**.
-2) Handlers layer where *handshakes & frames* are handled and translated to
+2. Handlers layer where *handshakes & frames* are handled and translated to
*messaeges*. Also socket connection is here to read/write frames.
All API at this layer is **PRIVATE**.
-3) Frames layer implements actual parsing of the raw data from sockets. Validates
+3. Frames layer implements actual parsing of the raw data from sockets. Validates
frames and sends them to the Handler layer.
All API at this layer is **PRIVATE**.
@@ -65,6 +65,12 @@ methods:
- (NSData *)textFramePayloadWithString:(NSString *)string;
- (NSData *)binaryFramePayloadWithData:(NSData *)aData;
+## Test suite
+
+Project has a test suite. Most of the tests are Unit tests of the separate classes
+but for PKWebSocket there are bunch of the integration tests which requires you
+to be connected to internet as it connects to *ws://echo.websocket.org*.
+
# Compatibility
@@ -144,7 +150,7 @@ probably need to set some TLS settings.
# Get code & Contribute
-TOWRITE
+I'm grateful for any contributions no matter if it's bug report or patch!
## Code
@@ -159,21 +165,28 @@ or, earlier...
git submodule init
git submodule update
-## Test suite
-
-TOWRITE
-
# Adding to your project
-You can add PKWebSocket to your project in two ways:
+You can add PKWebSocket to your project in two ways.
## XCode 4.x sub-project
+1. Drag-Drop PKWebSocket.xcodeproj in your project
+2. Add `libPKWebSocket.a` to your Link Binary With Libraries You might need to add `CFNetwork.framework` as well.
+3. Add `-ObjC` and `-all_load` to your **Other Linker Flags**
+4. Add $(BUILT_PRODUCTS_DIR) to your **Libray Search Paths** & **Header Search Paths**, mark recursive
+
+Now you should be able to compile your project with the PKWebSocket. You can validate
+settings by going to the **Derived data folder** where you should see
+`libPKWebSocket.a` and **PKWebSocket directory with header files**.
+
## Get the static library binary release (TODO)
+I first need to push the release.
+
-# Based on
+# Based on the projects
* Originally created for Zimt by Esad Hajdarevic (https://github.com/esad/zimt)
* Erich Ocean made the code more generic (https://github.com/erichocean/cocoa-websocket)

0 comments on commit 5c2aa26

Please sign in to comment.