Merge pull request #64 from Novage/feat/readme

Readme file
Novage · Feb 15, 2024 · 59956f6 · 59956f6
2 parents 269eb6a + 7cf412d
commit 59956f6
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 44 deletions.
diff --git a/.github/workflows/coveralls.yml → .github/workflows/main.yml b/.github/workflows/coveralls.yml → .github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: Tests
+name: Build & Test main
 
 on:
   push:
@@ -15,7 +15,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "20"
 
       - name: Install dependencies
         run: npm install

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -0,0 +1,23 @@
+name: Build & Test PR
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm run test:coverage
diff --git a/README.md b/README.md
@@ -1,29 +1,30 @@
-[![Build Status](https://travis-ci.org/Novage/wt-tracker.svg?branch=master)](https://travis-ci.org/Novage/wt-tracker)
 [![Coverage Status](https://coveralls.io/repos/github/Novage/wt-tracker/badge.svg?branch=master)](https://coveralls.io/github/Novage/wt-tracker?branch=master)
+
 # wt-tracker
+
 High-performance WebTorrent tracker.
 
 WebTorrent tracker is a required component of [WebTorrent](https://github.com/webtorrent/webtorrent) and [P2P Media Loader](https://github.com/Novage/p2p-media-loader) (peer-to-peer networks for web browsers) to do [WebRTC](https://en.wikipedia.org/wiki/WebRTC) signaling - exchanging connection data (i.e. [SDP](https://en.wikipedia.org/wiki/Session_Description_Protocol)) between peers - joining them into swarms.
 
 ## Features
 
-* handles more than 40k WebSocket Secure (HTTPS) peers on a VPS with only 2 GiB memory and 1 virtual CPU thanks to [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) I/O backend and perfomance optimizations in the code
-* handles ws:// (HTTP) and wss:// (HTTPS) connections simultaneously
-* IPv4 and IPv6 support
-* robust and well-tested: CI, unit tests, static code analyzis, 100% TypeScript
-* supports tracker "scrape" extension
-* statistics under /stats.json URL
+- handles more than 40k WebSocket Secure (HTTPS) peers on a VPS with only 2 GiB memory and 1 virtual CPU thanks to [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) I/O backend and perfomance optimizations in the code
+- handles ws:// (HTTP) and wss:// (HTTPS) connections simultaneously
+- IPv4 and IPv6 support
+- robust and well-tested: CI, unit tests, static code analyzis, 100% TypeScript
+- supports tracker "scrape" extension
+- statistics under /stats.json URL
 
 ## Related projects
 
-* [P2P Media Loader](https://github.com/Novage/p2p-media-loader) - an open-source engine for P2P streaming of live and on demand video directly in a web browser HTML page
-* [Novage, LLC](https://novage.com.ua/) - P2P development, support & consulting
-* [WebTorrent](https://github.com/webtorrent/webtorrent) - streaming torrent client for the web https://webtorrent.io
-* [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) - the Node.js bindings to µWebSockets, one of the most efficient web servers available
+- [P2P Media Loader](https://github.com/Novage/p2p-media-loader) - an open-source engine for P2P streaming of live and on demand video directly in a web browser HTML page
+- [Novage, LLC](https://novage.com.ua/) - P2P development, support & consulting
+- [WebTorrent](https://github.com/webtorrent/webtorrent) - streaming torrent client for the web https://webtorrent.io
+- [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) - the Node.js bindings to µWebSockets, one of the most efficient web servers available
 
 ## Build instructions
 
-Node.js 10+ is required.
+Node.js 16+ is required.
 
 ```sh
 npm install
@@ -52,15 +53,15 @@ npm start [config.json]
 
 See [config.json](sample/config.json)
 
-|Name|Type|Description|
-|----|----|-----------|
-|servers.websockets.path|string|URL pattern for the WebSockets endpoint|
-|servers.websockets.maxPayloadLength|number|The maximum length of received message|
-|servers.websockets.midleTimeout|number|The maximum amount of seconds that may pass without sending or getting a message. Being idle for more than this, and the connection is severed.|
-|servers.websockets.compression|0,1,2|0 = no compression, 1 = shared compressor, 2 = dedicated compressor (see [details](https://github.com/uNetworking/uWebSockets/blob/master/misc/READMORE.md#settings))|
-|servers.websockets.maxConnections|number|The maximum number of WebSocket connections. 0 = no limit.|
-|tracker.maxOffers|number|The maximum number of client's WebRTC SDP offers that are processed|
-|tracker.announceInterval|number|Desired announce interval in seconds required from the clients|
+| Name                                | Type   | Description                                                                                                                                                           |
+| ----------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| servers.websockets.path             | string | URL pattern for the WebSockets endpoint                                                                                                                               |
+| servers.websockets.maxPayloadLength | number | The maximum length of received message                                                                                                                                |
+| servers.websockets.midleTimeout     | number | The maximum amount of seconds that may pass without sending or getting a message. Being idle for more than this, and the connection is severed.                       |
+| servers.websockets.compression      | 0,1,2  | 0 = no compression, 1 = shared compressor, 2 = dedicated compressor (see [details](https://github.com/uNetworking/uWebSockets/blob/master/misc/READMORE.md#settings)) |
+| servers.websockets.maxConnections   | number | The maximum number of WebSocket connections. 0 = no limit.                                                                                                            |
+| tracker.maxOffers                   | number | The maximum number of client's WebRTC SDP offers that are processed                                                                                                   |
+| tracker.announceInterval            | number | Desired announce interval in seconds required from the clients                                                                                                        |
 
 ## Index HTML page
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
   "types": "dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=16.0.0"
   },
   "bin": {
     "wt-tracker": "./bin/wt-tracker"
@@ -49,7 +49,7 @@
     "@types/chai": "^4.3.11",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.17",
+    "@types/node": "^20.11.18",
     "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
     "@typescript-eslint/parser": "^7.0.1",

diff --git a/travis.yml b/travis.yml