From a150deb10a8e76dd3d1c071f48a05395131410b2 Mon Sep 17 00:00:00 2001 From: Giles Hall Date: Tue, 2 Feb 2016 14:31:55 -0500 Subject: [PATCH] doc fixes --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f2935d..c940c50 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -=Wait for it= +# Wait for it -wait-for-it.sh is a pure bash script that wait on the availability of a host and TCP port. It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers. Since it is a pure bash script, it does not have any external dependencies. +`wait-for-it.sh` is a pure bash script that wait on the availability of a host and TCP port. It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers. Since it is a pure bash script, it does not have any external dependencies. -==Usage== +## Usage ``` wait-for-it.sh host:port [-s] [-t timeout] [-- command args] @@ -16,9 +16,9 @@ wait-for-it.sh host:port [-s] [-t timeout] [-- command args] -- COMMAND ARGS Execute command with args after the test finishes ``` -==Examples== +## Examples -For example, let's test to see if we can access port 80 on www.google.com, and if it is available, echo the message "Let's start googling!" +For example, let's test to see if we can access port 80 on www.google.com, and if it is available, echo the message `google is up`. ``` $ ./wait-for-it.sh www.google.com:80 -- echo "google is up"