Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sumo-MBryant committed Jun 7, 2014
1 parent 3104a48 commit 8f8b9ad
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -51,6 +51,7 @@ Following options can be passed to WebSocket::EventMachine::Client initializer:
- `[Integer] :port` - Port of server to connect
- `[String] :uri` - Full URI for server(optional - use instead of host/port combination)
- `[Integer] :version` - Version of WebSocket to use. Default: 13
- `[Hash] :headers` - HTTP headers to use in the handshake. Example: `{'Cookie' => 'COOKIENAME=Value'}`

## Methods

Expand Down
2 changes: 2 additions & 0 deletions lib/websocket/eventmachine/client.rb
Expand Up @@ -20,6 +20,7 @@ class Client < Base
# @option args [String] :host The host IP/DNS name
# @option args [Integer] :port The port to connect too(default = 80)
# @option args [Integer] :version Version of protocol to use(default = 13)
# @option args [Hash] :headers HTTP headers to use in the handshake
def self.connect(args = {})
host = nil
port = nil
Expand All @@ -40,6 +41,7 @@ def self.connect(args = {})
# @option args [String] :host The host IP/DNS name
# @option args [Integer] :port The port to connect too(default = 80)
# @option args [Integer] :version Version of protocol to use(default = 13)
# @option args [Hash] :headers HTTP headers to use in the handshake
def initialize(args)
@args = args
end
Expand Down

0 comments on commit 8f8b9ad

Please sign in to comment.