diff --git a/README.md b/README.md index 127390b..48dbef8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # ab-netcat -Simple netcat echo server on customizable port \ No newline at end of file +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 [:]: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!