Skip to content

Commit 813c3e4

Browse files
committed
docs: update README
- remove references at µWebSockets - simplify header
1 parent 766ce58 commit 813c3e4

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
# Sigver
22

3-
WebRTC Signaling server based on **WebSocket** for [**Netflux API**](https://coast-team.github.io/netflux), Javascript client and server side transport API for establishing peer to peer network.
4-
3+
[![travis](https://travis-ci.org/coast-team/sigver.svg?branch=master&style=flat-square)](https://travis-ci.org/coast-team/sigver)
54
[![version](https://img.shields.io/npm/v/sigver.svg?style=flat-square)](https://www.npmjs.com/package/sigver)
6-
[![node-version](https://img.shields.io/node/v/sigver.svg?style=flat-square)](https://nodejs.org/en/)
75

8-
[![travis](https://travis-ci.org/coast-team/sigver.svg?branch=master&style=flat-square)](https://travis-ci.org/coast-team/sigver)
9-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
10-
[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli)
6+
WebRTC Signaling server based on **WebSocket** for [**Netflux API**](https://coast-team.github.io/netflux), Javascript client and server side transport API for establishing peer to peer network.
117

128
## Install
139

1410
```shell
1511
npm install -g sigver
1612
```
1713

18-
Sigver is built on top of [µWebSockets](https://github.com/uNetworking/uWebSockets) server. If you encounter any problem with its installation, please check the project's repository.
19-
2014
## Run
2115

2216
```shell
@@ -93,3 +87,4 @@ Server may close the socket with the following codes:
9387
- **ERR_HEARTBEAT = 4742** // Heart-beats error
9488
- **ERR_MESSAGE = 4743** // Any error due to message: type, format etc.
9589
- **ERR_BLOCKING_MEMBER = 4744** // When only one member left in the group and new peers could not join via him.
90+

0 commit comments

Comments
 (0)