From 8e033bc8716bfdea424b81c0596f6d9cbaba8f1b Mon Sep 17 00:00:00 2001 From: Fernando Paladini Date: Thu, 28 Sep 2017 12:14:36 -0300 Subject: [PATCH] Update README.md Improve installation instructions --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f0d277..eb7349c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ # Intercom Export -Export data from Intercom. +Export data from Intercom. Currently supports only conversations. ## Installation -See [mruby-cli](https://github.com/hone/mruby-cli) for more details. +### Dependencies + +- `docker`: check installation instructions [in Docker official website](https://www.docker.com/). +- `mruby-cli`: actually don't need to install, Docker will handle this dependency. Anyway, see [mruby-cli](https://github.com/hone/mruby-cli) for more details. + +After installing and configuring `docker` and `docker-compose`, you'll be able to install Intercom Export, `mruby-cli` and other needed dependencies with a single Docker command. In order to do that, just clone/download this project into your PC and run the following command from your Terminal (run inside this project folder): ``` docker-compose run compile ``` +And you're done! + ## Usage For now, you can only export all the conversations and prints them on stdout