UNPKG

chat-service/README.md

Version:

714 BMarkdownView Raw

1
2# Chat service
3
4[![Build Status](https://travis-ci.org/an-sh/chat-service.svg?branch=master)](https://travis-ci.org/an-sh/chat-service)
5[![Coverage Status](https://coveralls.io/repos/an-sh/chat-service/badge.svg?branch=master&service=github)](https://coveralls.io/github/an-sh/chat-service?branch=master)
6[![Dependency Status](https://david-dm.org/an-sh/chat-service.svg)](https://david-dm.org/an-sh/chat-service)
7
8Server side chat based on top of socket.io
9
10### Documentation
11
12Run `npm run-script codo` to generate documentation.
13
14Look in the test directory, for socket.io-client messages and server
15setup examples.
16
17### TODO
18
19- More documentation.
20- Redis state adapter.
21- API for extensions.
22
23### License
24
25MIT

1
2	`# Chat service`
3
4	`[![Build Status](https://travis-ci.org/an-sh/chat-service.svg?branch=master)](https://travis-ci.org/an-sh/chat-service)`
5	`[![Coverage Status](https://coveralls.io/repos/an-sh/chat-service/badge.svg?branch=master&service=github)](https://coveralls.io/github/an-sh/chat-service?branch=master)`
6	`[![Dependency Status](https://david-dm.org/an-sh/chat-service.svg)](https://david-dm.org/an-sh/chat-service)`
7
8	`Server side chat based on top of socket.io`
9
10	`### Documentation`
11
12	Run `npm run-script codo` to generate documentation.
13
14	`Look in the test directory, for socket.io-client messages and server`
15	`setup examples.`
16
17	`### TODO`
18
19	`- More documentation.`
20	`- Redis state adapter.`
21	`- API for extensions.`
22
23	`### License`
24
25	`MIT`