From 8fda3723feaebe0a43482e90b3405382920b8758 Mon Sep 17 00:00:00 2001 From: Nicolas CARPi <3043706+NicolasCARPi@users.noreply.github.com> Date: Fri, 19 Jul 2019 13:53:16 +0200 Subject: [PATCH] Improve the docker command in README * No need to run the pull command first, as the run command will take care of this -> decrease number of commands to run by 50% :p * Use `--rm` flag to remove the container after use * Make the command slightly shorter * Use bash syntax coloration --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07e8a97..4c18378 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,11 @@ In order to use Astronomer, you'll need a GitHub token with `repo` read rights. ### Docker image -Run `docker pull ullaakut/astronomer`. +Run the astronomer docker image like such: -Then, use the astronomer docker image like such: `docker run -t -e GITHUB_TOKEN=$GITHUB_TOKEN -v "/path/to/your/cache/folder:/data/" ullaakut/astronomer repositoryOwner/repositoryName` +~~~bash +docker run --rm -t -e GITHUB_TOKEN=$TOKEN -v "/path/to/cache:/data" ullaakut/astronomer repositoryOwner/repositoryName +~~~ * The `-t` flag allows you to get a colored output. You can remove it from the command line if you don't care about this. * The `-e GITHUB_TOKEN=` option is mandatory. The GitHub API won't authorize any requests without it.