From e11141d1eb362f3f5f88560f49538aff20747e1e Mon Sep 17 00:00:00 2001 From: BoHong Li Date: Wed, 27 Nov 2019 08:04:51 +0800 Subject: [PATCH] doc: add readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c37f7a8 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# portchecker + +portchecker is a simple application to check the port of host is connectable or not + +## Usage + +``` +portchecker [-constr connection string] [-env environment-variable-name] [-attempt maximum-attempt-times] [-wait connection-failed-waiting-time] + -constr connection string under test + example: + tcp://127.0.0.0.1:1234 + postgres://localhost/test + mysql://testuser:password@mysql-host.local:1234 + redis://localhost + + -env environment variable name + example: + DB_URL + REDIS_URL + + -attempt how many times to try, default: 5 times + -wait wait how many time to try next time, default: 3s +```