From 0dd72f7bdca20086243530bc168fd6ac3e74067a Mon Sep 17 00:00:00 2001 From: Alex Hultman <3397140+alexhultman@users.noreply.github.com> Date: Mon, 5 Nov 2018 00:00:00 +0100 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9c16fb2..078b60c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ -Loopery is Google V8 tied to µWebSockets for building high performance JavaScript backend services. +**µWebSockets.js** is a JavaScript platform, runtime and web server. It can serve Http about 6x that of Node.js and 12x that of Deno and outperforms Golang's fasthttp with ease. + +There are two modes; compiled as a stand-alone JavaScript runtime or as a Node.js native addon. ```javascript -const uWS = require('...lalala'); +/* The stand-alone runtime has uWS namespace already loaded. */ +var uWS = uWS ? uWS : require('../dist/uws.js'); -const app = uWS.SSLApp({ - cert: 'my_cert.pem', - key: 'my_key.pem' -}).get('/whatsmy/useragent', (res, req) => { - res.end('Hello ' + req.getHeader('user-agent')); +const world = 'Strings are slower than ArrayBuffer but who cares for demo purose!'; +const port = 3000; + +uWS.App().get('/hello', (res, req) => { + res.end(world); }).get('/*', (res, req) => { - res.end('Hello otherwise!'); -}).listen(3000, 0, (token) => { - console.log('Listening to port 3000'); + res.writeHeader('content-type', 'text/html; charset= utf-8').end(req.getHeader('user-agent') + ' är din user agent, biatch!'); +}).listen(port, (token) => { + if (token) { + console.log('Listening to port ' + port); + } else { + console.log('Failed to listen to port ' + port); + } }); ``` @@ -20,10 +27,10 @@ Performance retention is up to 70% of native C++ µWebSockets v0.15. ![](benchmarks.png) ### Kick-start -The following works for Linux and macOS systems: +Easiest is to compile yourself a Node.js native addon. The following works for Linux and macOS systems: ``` -git clone --recursive https://github.com/uNetworking/uWebSockets-node.git -cd uWebSockets-node +git clone --recursive https://github.com/uNetworking/uWebSockets.js.git +cd uWebSockets.js make node examples/HelloWorld.js ```