Skip to content

Commit 40236a9

Browse files
committed
Update development control plane screenshot
* Add instructions on how to manually start the develoment control plane
1 parent ca30897 commit 40236a9

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Go WebSockify is a pure Go implementation of [novnc/websockify](https://github.c
99
- [Usage](#usage)
1010
- [Development](#development)
1111
- [Dependencies](#dependencies)
12-
- [Start development environment](#start-development-environment)
13-
- [Development control plane](#development-control-plane)
12+
- [Development environment](#development-environment)
13+
- [Control plane](#control-plane)
1414
- [Screenshots](#screenshots)
1515
- [Contributing](#contributing)
1616
- [License](#license)
@@ -49,16 +49,24 @@ Flags:
4949
- [Yarn](https://yarnpkg.com/getting-started/install)
5050
- [Modd](https://github.com/cortesi/modd)
5151

52-
### Start development environment
52+
### Development environment
5353
[Modd](https://github.com/cortesi/modd) is used for a seamless development experience and once installed simply run the command `modd` in the root directory of this project to start the development environment.
5454

55-
### Development control plane
56-
`go-websockify` has a simple control plane for development in `/client` and is available at: http://127.0.0.1:1234 during development. For the frontend to connect you have to pass `--echo` as a command line flag. **This is done for you if you're using Modd.**
55+
### Control plane
56+
`go-websockify` has a simple JavaScript based frontend control plane for development and is available at http://127.0.0.1:1234.
57+
58+
```shell
59+
$ cd client
60+
$ yarn install
61+
$ yarn dev
62+
```
63+
64+
> For the frontend to automatically connect to Go WebSockify you have to pass `--echo` as a command line flag to `go-websockify`. **This is done for you if you're using Modd.**
5765
5866
### Screenshots
59-
<img src="screenshots/go-websockify-control-plane.jpg">
67+
<img align="center" src="screenshots/go-websockify-control-plane.jpg">
6068

61-
> The control plane is not included with binary distributions.
69+
> The development control plane is not included with binary distributions.
6270
6371
## Contributing
6472
Both pull requests and issues are welcome on [GitHub](https://github.com/msquee/go-websockify). No set rules for contributing, just keep it clean.
92.3 KB
Loading

0 commit comments

Comments
 (0)