Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
informationsea committed Jul 24, 2020
1 parent 57993ff commit 587d710
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sudo: required
env:
global:
# TODO Update this to match the name of your project.
- CRATE_NAME=trust
- CRATE_NAME=websockify-rs

matrix:
# TODO These are all the build jobs. Adjust as necessary. Comment out what you
Expand Down
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
# WebSockify-rs

Rust implementation of [WebSockify](https://github.com/novnc/websockify).
noVNC files are embedded in websockify-rs for easy use.

## Usage

```
WebSockify-rs 0.1.0
Okamura Yasunobu
Convert TCP/Unix doamin socket connection to WebSocket
USAGE:
websockify-rs [FLAGS] [OPTIONS] <upstream> <listen>
FLAGS:
-h, --help Prints help information
-l, --lisnten-unix Listen path is unix domain socket
-u, --upstream-unix Upstream is unix domain socket
-V, --version Prints version information
-v, --verbose
OPTIONS:
-p, --prefix <prefix> server prefix
ARGS:
<upstream> Upstream host:port
<listen> Listen host:port
```

## Example

```
$ vncserver
$ ./websockify-rs localhost:5901 127.0.0.1:8080
```

Access to [http://127.0.0.1/static/vnc.html](http://127.0.0.1/static/vnc.html)
6 changes: 5 additions & 1 deletion ci/before_deploy.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ Set-Location $STAGE
$ZIP = "$SRC_DIR\$($Env:CRATE_NAME)-$($Env:APPVEYOR_REPO_TAG_NAME)-$($Env:TARGET).zip"

# TODO Update this to package the right artifacts
Copy-Item "$SRC_DIR\target\$($Env:TARGET)\release\hello.exe" '.\'
Copy-Item "$SRC_DIR\target\$($Env:TARGET)\release\websockify-rs.exe" '.\'
Copy-Item "$SRC_DIR\README.md" '.\'
Copy-Item "$SRC_DIR\LICENSE" '.\LICENSE'
Copy-Item "$SRC_DIR\websockify-rs/noVNC/README.md" '.\README-novnc.md'
Copy-Item "$SRC_DIR\cp websockify-rs/noVNC/LICENSE.txt" '.\LICENSE-novnc.txt'

7z a "$ZIP" *

Expand Down

0 comments on commit 587d710

Please sign in to comment.