diff --git a/README.md b/README.md index fc65ea5..9223683 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,27 @@ -## Wait for another service to become available +# wait-for `./wait-for` is a script designed to synchronize services like docker containers. It is [sh](https://en.wikipedia.org/wiki/Bourne_shell) and [alpine](https://alpinelinux.org/) compatible. It was inspired by [vishnubob/wait-for-it](https://github.com/vishnubob/wait-for-it), but the core has been rewritten at [Eficode](http://eficode.com/) by [dsuni](https://github.com/dsuni) and [mrako](https://github.com/mrako). When using this tool, you only need to pick the `wait-for` file as part of your project. -[![Build Status](https://travis-ci.org/eficode/wait-for.svg?branch=master)](https://travis-ci.org/eficode/wait-for) - ## Usage +```Shell +$ ./wait-for host:port [-t timeout] [-- command args] + -q | --quiet Do not output any status messages + -t TIMEOUT | --timeout=timeout Timeout in seconds, zero for no timeout + -- COMMAND ARGS Execute command with args after the test finishes ``` -./wait-for host:port [-t timeout] [-- command args] - -q | --quiet Do not output any status messages - -t TIMEOUT | --timeout=timeout Timeout in seconds, zero for no timeout - -- COMMAND ARGS Execute command with args after the test finishes -``` + +## Dependencies + +* installed Netcat ## Examples To check if [eficode.com](https://eficode.com) is available: -``` +```Shell $ ./wait-for www.eficode.com:80 -- echo "Eficode site is up" Connection to www.eficode.com port 80 [tcp/http] succeeded! @@ -28,8 +30,7 @@ Eficode site is up To wait for database container to become available: - -``` +```Yaml version: '2' services: @@ -47,14 +48,18 @@ services: Ironically testing is done using [bats](https://github.com/sstephenson/bats), which on the other hand is depending on [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)). - docker build -t wait-for . - docker run -t wait-for - -## Note - -Make sure netcat is installed in your Dockerfile before running the command. +```Shell +docker build -t wait-for . +docker run -t wait-for ``` -RUN apt-get -q update && apt-get -qy install netcat -``` -https://stackoverflow.com/questions/44663180/docker-why-does-wait-for-always-time-out +### License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +### Maintainers and Contributors + +[Robert Kaussow](https://github.com/xoxys) + +[eficode](https://github.com/eficode) +[Marko Klemetti](https://github.com/mrako)