Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
- remove references at µWebSockets
- simplify header
  • Loading branch information
Conaclos committed Apr 25, 2020
1 parent 766ce58 commit 813c3e4
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
# Sigver

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.

[![travis](https://travis-ci.org/coast-team/sigver.svg?branch=master&style=flat-square)](https://travis-ci.org/coast-team/sigver)
[![version](https://img.shields.io/npm/v/sigver.svg?style=flat-square)](https://www.npmjs.com/package/sigver)
[![node-version](https://img.shields.io/node/v/sigver.svg?style=flat-square)](https://nodejs.org/en/)

[![travis](https://travis-ci.org/coast-team/sigver.svg?branch=master&style=flat-square)](https://travis-ci.org/coast-team/sigver)
[![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)
[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli)
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.

## Install

```shell
npm install -g sigver
```

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.

## Run

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

0 comments on commit 813c3e4

Please sign in to comment.