diff --git a/README.md b/README.md index 20eaba6..4e27d56 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # antd-wvnc-plugin +An [Antd HTTP/HTTPS server's](https://github.com/lxsang/ant-http) plugin that acts as a bridge between a VNC server and web applications. It allows web application to communicate with VNC server using web socket via a predefined protocol and message format. + +To speed up the data transmission, **WVNC** uses **libjpeg** and **zlib** for data compression. + +## Demo +A demo will soon be available + ## Dependencies +* ANTD: As **WVNC** is an **Antd** plugin, it need to be built using the server build system * Zlib -* libjpeg-turbo \ No newline at end of file +* libjpeg-turbo + +## Build + +A build script will soon be available