jprdonnelly/uWebSockets.js
1
0
Fork 0
mirror of https://github.com/uNetworking/uWebSockets.js.git synced 2025-12-25 02:16:26 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
uNetworkingAB
2024-07-19 20:54:21 +02:00
committed by GitHub
parent 1985dc987b
commit 675b6be56d
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -5,12 +5,14 @@
<a href="https://github.com/uNetworking/uWebSockets.js/releases"><img src="https://img.shields.io/github/v/release/uNetworking/uWebSockets.js"></a> <a href="https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:uwebsockets"><img src="https://oss-fuzz-build-logs.storage.googleapis.com/badges/uwebsockets.svg" /></a> <img src="https://img.shields.io/badge/established-in%202016-green" /> <a href="https://twitter.com/uNetworkingAB"><img src="https://raw.githubusercontent.com/uNetworking/uWebSockets/master/misc/follow.png" height="20"/></a>
</div>
<br><br>
<br>
### :zap: Simple performance
µWebSockets.js is a standards compliant web server written in 10,000 lines of C++. It is exposed to Node.js as a native V8 addon and performs 10x that of Socket.IO, 8.5x that of Fastify. It makes up the core components of Bun and is the fastest standards compliant web server in the TechEmpower (not endorsed) benchmarks.
µWebSockets.js is a standards compliant web server written in 10,000 lines of C++. It is exposed to Node.js as a simple-to-use, native V8 addon and performs at least **[10x that of Socket.IO](https://medium.com/swlh/100k-secure-websockets-with-raspberry-pi-4-1ba5d2127a23)**, [8.5x that of Fastify](https://alexhultman.medium.com/serving-100k-requests-second-from-a-fanless-raspberry-pi-4-over-ethernet-fdd2c2e05a1e). It makes up the **[core components of Bun](https://twitter.com/uNetworkingAB/status/1810380862556397887)** and is the **[fastest standards compliant web server](https://x.com/uNetworkingAB/status/1812914159295869075)** in the TechEmpower (**[not endorsed](https://x.com/uNetworkingAB/status/1811425564764610926)**) benchmarks.
We aren't in the NPM registry but you can install it with the NPM client: `npm install uNetworking/uWebSockets.js#v20.44.0`
We aren't in the NPM registry but you can easily install it with the NPM client:
* `npm install uNetworking/uWebSockets.js#v20.44.0`
* Browse the documentation and see the main repo. There are tons of examples but here's the gist of it all:
### :dash: In essence