Skip to content

Commit e7eac12

Browse files
committed
Expand README, slightly
1 parent 11302b3 commit e7eac12

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1-
# wush - wireguard powered shells and file transfers behind nat
1+
# wush
22

33
[![Go Reference](https://pkg.go.dev/badge/github.com/coder/wush.svg)](https://pkg.go.dev/github.com/coder/wush)
4+
5+
`wush` is a command line tool that lets you easily transfer
6+
files and open shells over a peer-to-peer wireguard connection. It's similar to [magic-wormhole](https://github.com/magic-wormhole/magic-wormhole) but doesn't require you to
7+
set up a relay server.
8+
9+
## Basic Usage
10+
11+
```
12+
go install github.com/coder/wush/cmd/wush@latest
13+
```

0 commit comments

Comments
 (0)