Skip to content

Commit

Permalink
quick readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
fed135 committed Apr 2, 2016
1 parent f140a16 commit 6a77dff
Showing 1 changed file with 36 additions and 36 deletions.
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,41 +17,6 @@ A library to simplify and optimize your Socket communications.
- Ultra-flexible and extensible


## Adapters

Allow you to easily use different socket types, hassle-free

| **Type** | **Library used** | **Status** |
|---|---|---|
| IPC | | STABLE |
| TCP | | STABLE |
| UDP | | STABLE |
| Web Socket | [kalm-websocket](https://github.com/fed135/kalm-websocket) | DEV |


## Encoders

Encode the payloads before emitting.

| **Type** | **Library used** | **Status** |
|---|---|---|
| JSON | | STABLE |
| MSG-PACK | [msgpack-lite](https://github.com/kawanet/msgpack-lite) | STABLE |


## Middleware

Perform batch operation of payloads.

| **Type** | **Library used** | **Status** |
|---|---|---|
| Bundler | | STABLE |

---

The framework is flexible enough so that you can load your own custom adapters, encoders or middlewares - say you wanted support for protocols like zmq, WebSockets or have yaml encoding.


## Installation

npm install kalm
Expand Down Expand Up @@ -112,6 +77,41 @@ The framework is flexible enough so that you can load your own custom adapters,
*Using wireshark - number of bytes transfered per 1000 requests*


## Adapters

Allow you to easily use different socket types, hassle-free

| **Type** | **Library used** | **Status** |
|---|---|---|
| IPC | | STABLE |
| TCP | | STABLE |
| UDP | | STABLE |
| [kalm-websocket](https://github.com/fed135/kalm-websocket) | [socket.io](http://socket.io/) | DEV |


## Encoders

Encode the payloads before emitting.

| **Type** | **Library used** | **Status** |
|---|---|---|
| JSON | | STABLE |
| MSG-PACK | [msgpack-lite](https://github.com/kawanet/msgpack-lite) | STABLE |


## Middleware

Perform batch operation of payloads.

| **Type** | **Library used** | **Status** |
|---|---|---|
| Bundler | | STABLE |

---

The framework is flexible enough so that you can load your own custom adapters, encoders or middlewares - say you wanted support for protocols like zmq, WebSockets or have yaml encoding.


## Run tests

npm test
Expand All @@ -136,4 +136,4 @@ Ex:
I am looking for contributors to help improve the codebase and create adapters, encoders and middleware.
Email me for details.

Thank you!
Thank you!

0 comments on commit 6a77dff

Please sign in to comment.