From 4f99c9bfa9d371b3257546500716cd417116c5fe Mon Sep 17 00:00:00 2001 From: Alex Hultman Date: Fri, 9 Mar 2018 20:02:25 +0100 Subject: [PATCH] Link to wiki & user manual --- DETAILS.md | 30 ------------------------------ README.md | 2 +- 2 files changed, 1 insertion(+), 31 deletions(-) delete mode 100644 DETAILS.md diff --git a/DETAILS.md b/DETAILS.md deleted file mode 100644 index f0be53432..000000000 --- a/DETAILS.md +++ /dev/null @@ -1,30 +0,0 @@ -#### Features - -* Autobahn tests [all pass](http://htmlpreview.github.io/?https://github.com/uWebSockets/uWebSockets/blob/master/misc/autobahn/index.html). -* One million WebSockets require ~111mb of user space memory (104 bytes per WebSocket). -* Single-threaded throughput of up to 5 million HTTP req/sec or 20 million WebSocket echoes/sec. -* Linux, OS X, Windows & [Node.js](http://github.com/uWebSockets/bindings) support. -* Runs with raw epoll, libuv or ASIO (C++17-ready). -* Valgrind & AddressSanitizer clean. -* Permessage-deflate, SSL/TLS support & integrates with foreign HTTP(S) servers. -* Multi-core friendly & optionally thread-safe via compiler flag UWS_THREADSAFE. - -#### Dependencies -First of all you need to install the required dependencies. This is very easily done with a good open source package manager like [Homebrew](http://brew.sh) for OS X, [vcpkg](https://github.com/Microsoft/vcpkg) for Windows or your native Linux package manager. - -* OpenSSL 1.x.x -* zlib 1.x -* libuv 1.3+ *or* Boost.Asio 1.x (both optional on Linux) - -If you wish to integrate with a specific event-loop you can define `USE_ASIO` or `USE_LIBUV` as a global compilation flag and then link to respective libraries. `USE_EPOLL` is default on Linux while other systems default to `USE_LIBUV`. - -* Fedora: `sudo dnf install openssl-devel zlib-devel` -* Homebrew: `brew install openssl zlib libuv` -* Vcpkg: `vcpkg install openssl zlib libuv` *and/or* `vcpkg install openssl:x64-windows zlib:x64-windows libuv:x64-windows` - -#### Compilation -###### OS X & Linux -* `make` -* `sudo make install` (or as you wish) -###### Windows -* Compile `VC++.vcxproj` with Visual C++ Community Edition 2015 or later. diff --git a/README.md b/README.md index d97f0e2a8..189f9e1ba 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ µWS ("[micro](https://en.wikipedia.org/wiki/Micro-)WS") is a WebSocket and HTTP implementation for clients and servers. Simple, efficient and lightweight. -[Read more](DETAILS.md) +[Wiki pages & user manual](https://github.com/uNetworking/uWebSockets/wiki/User-manual-v0.14.x) #### Build optimized WebSocket & HTTP servers & clients in no time. ```c++