Adds a very simple readme

This commit is contained in:
Jonathan Hodgson 2020-06-03 21:01:39 +01:00
parent d6aa47373d
commit 7347860e1e

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# Resize NC Listener
This is designed to be used in place of a nc listener.
## Usage
```bash
resize-netcat-listener 4444
```
This will listen on port 4444 for an incoming connection. Nothing ground breaking here. If you want it to listen on UDP, you can specify the `-u` flag.
The interesting part (in my opinion) is that you can specify a command to be run when the window is resized.
```bash
resize-netcat-listener -r examples/stty-resize-copy 4444
```
This example will determine the new size of the window and put an appropriate stty command on the clipboard. This is useful if you have got a reverse shell as the remote shell isn't able to listen for resize events.
## Sources
Some code was taken from here: <https://github.com/vfedoroff/go-netcat>