From 5e99ca6415d9a4fb849114c4a2e91ab7278085db Mon Sep 17 00:00:00 2001 From: Manish Sharma Date: Sat, 9 Oct 2021 15:29:53 +0530 Subject: [PATCH] [UPDATES] Updated README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0af3f4d..617bf43 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,22 @@ If You are using an old version of Ruby, You may run Bundle's script with a spec ### Check Heartcheck example [here](https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb) +## Development setup using Docker + +The Docker Hearthcheck-Redis provides a container with the current stable version of Ruby released and a second Docker container running Memcached. The development setup requires you to have these tools available in your local environment: + +- [Docker](https://docs.docker.com/get-docker/) +- [Docker Compose](https://docs.docker.com/compose/install/) +- [Bash](https://www.gnu.org/software/bash/) + +#### BootStrap Script to run the dockerized environment + +```bash +./scripts/heartcheck-redis setup +``` + +Run the command `./scripts/heartcheck-redis -h` to see available options. + ## License * [MIT License](https://github.com/locaweb/heartcheck-redis/blob/master/LICENSE.txt)