Skip to content

Commit 07fb561

Browse files
authored
Clean up README
1 parent 9120171 commit 07fb561

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# wsep
22

3-
`wsep` is a high performance,
4-
<strong style="font-size: 1.5em; text-decoration: underline;">w</strong>eb <strong style="font-size: 1.5em;text-decoration: underline;">s</strong>ocket command <strong style="font-size: 1.5em;text-decoration: underline;">e</strong>xecution <strong style="font-size: 1.5em;text-decoration: underline;">p</strong>rotocol. It can be thought of as SSH without encryption.
3+
`wsep` is a high performance command execution protocol over WebSocket. It can be thought of as SSH over WebSockets without encryption.
54

6-
It's useful in cases where you want to provide a command exec interface into a remote environment. It's implemented
7-
with WebSocket so it may be used directly by a browser frontend. Its symmetric design satisfies
8-
`wsep.Execer` for local and remote execution.
5+
The package offers the `wsep.Execer` interface so that local, SSH, and WebSocket execution can be interchanged. This is particular useful when testing.
96

107
## Examples
118

@@ -58,7 +55,7 @@ go run ./dev/client tty --id 1 -- bash
5855
go run ./dev/client notty -- ls -la
5956
```
6057

61-
### Local performance cost
58+
### Benchmarks
6259

6360
Local `sh` through a local `wsep` connection
6461

0 commit comments

Comments
 (0)