update readme

This commit is contained in:
Asif Bacchus 2020-02-07 07:33:19 -07:00
parent c5ab25c706
commit f0f701e2ea
1 changed files with 13 additions and 1 deletions

View File

@ -1,3 +1,15 @@
# ab-netcat
Simple netcat echo server on customizable port
Simple BSD-style netcat echo server. Run `docker run --rm docker.asifbacchus.app/ab-netcat help` for a quick-reference usage overview.
## Container usage
General usage:
`docker run [-d|-it] --init --rm -p [<ipaddr>:]<host port>:5555 [--name ab-netcat] [-e TZ=timezone] docker.asifbacchus.app/ab-netcat [/bin/sh]`
Please consult the repo [wiki](https://git.asifbacchus.app/ab-docker/ab-netcat/wiki) for detailed usage instructions and notes.
## Questions, Suggestions or Comments
Please create an issue if anything needs to be fixed or you have suggestions for enhancements. Otherwise, I hope it's useful to you!