Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README.md

  • Loading branch information...
commit 5b03d24cf4c28cad0552bed17b0e247024dd9779 1 parent 795f4f1
Paolo Fragomeni authored
Showing with 2 additions and 3 deletions.
  1. +2 −3 README.md
View
5 README.md
@@ -1,4 +1,3 @@
-
# Synposis
An elegant way to define lightweight protocols on-top of TCP/TLS sockets in node.js
@@ -31,7 +30,7 @@ Messages in `nssocket` are serialized JSON arrays of the following form:
Although this is not as optimal as other message formats (pure binary, msgpack) most of your applications are probably IO-bound, and not by the computation time needed for serialization / deserialization. When working with `NsSocket` instances, all events are namespaced under `data` to avoid collision with other events.
-## Example
+## Simple Example
``` js
var nssocket = require('nssocket');
@@ -68,7 +67,7 @@ Although this is not as optimal as other message formats (pure binary, msgpack)
outbound.connect(6785);
```
-## Reconnect
+## Reconnect Example
`nssocket` exposes simple options for enabling reconnection of the underlying socket. By default, these options are disabled. Lets look at a simple example:
``` js
Please sign in to comment.
Something went wrong with that request. Please try again.