Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Eelco committed Dec 19, 2011
1 parent c98765b commit be88a70
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ via a bosh-server and communicate willingly.
## Documentation for API ##

* Constructor: `Client(jid, password, bosh, route)`
- Parameters:
+ *jid* : [String] jabber id of user (e.g. `user@example.com/office`)
+ *password* : [String] password
+ *bosh* : [String] url of the bosh-server (e.g. `http://localhost:5280/http-bind/`)
+ *route* : [String] route attribute [if used] for connecting to xmpp server
- Return Value:
new Client Object having following properties:
Parameters:
*jid* : [String] jabber id of user (e.g. `user@example.com/office`)
*password* : [String] password
*bosh* : [String] url of the bosh-server (e.g. `http://localhost:5280/http-bind/`)
*route* : [String] route attribute [if used] for connecting to xmpp server
Return Value:
new Client Object having following properties:

1. Event-emitter for the following events

Expand Down

0 comments on commit be88a70

Please sign in to comment.