Skip to content

Update README.md with improved installation instructions #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paladini wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with improved installation instructions #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down