From 61f4dec7f3853a118107d5605be8097202392800 Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Sun, 31 Jan 2021 18:14:43 +0100 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d474af4..c43affd 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,33 @@ -# antd-wterm-plugin -**wterm** is an [antd plugin](https://github.com/lxsang/ant-http) providing the Terminal gateway to the web using websocket. +# antd-tunnel-plugin +**tunnel** is an [antd plugin](https://github.com/lxsang/ant-http) providing a generic purpose publish/subscribe message protocol using a single websocket connection. ## Build from source -As **wterm** is an **Antd's** plugin, the server must be pre-installed +As **tunnel** is an **Antd's** plugin, the server must be pre-installed ### build dep * git * make * build-essential +* ant-http (libantd.so) ### build When all dependencies are installed, the build can be done with a few single command lines: ```bash -mkdir antd -cd antd +mkdir tunnel +cd tunnel # replace x.x.x by a version number -wget -O- https://get.bitdojo.dev/antd_plugin | bash -s "wterm-x.x.x" +wget -O- https://get.iohub.dev/antd_plugin | bash -s "tunnel-x.x.x" # or install from a tarball distribution in dist/ -tar xvzf wterm-x.x.x.tar.gz -cd wterm-x.x.x +tar xvzf tunnel-x.x.x.tar.gz +cd tunnel-x.x.x ./configure --prefix=/opt/www --enable-debug=yes make sudo make install ``` - -## Run -To run the Antd server with the **wterm** plugin: -```sh -/path/to/your/build/antd -``` - -Web applications can be put on **/path/to/your/build/htdocs**, the web socket to **wterm** is available at: -``` -ws://your_host:your_port/wterm -``` -This websocket address can be used with [xterm.js](https://xtermjs.org) to provide web based termnial access - ### Generate distribution ```sh libtoolize @@ -47,4 +35,4 @@ aclocal autoconf automake --add-missing make distcheck -``` \ No newline at end of file +```