From 4e8ff192dc4a91e66a4d2d71266d4f01b8b93362 Mon Sep 17 00:00:00 2001 From: Red5d Date: Sat, 7 Aug 2021 14:06:52 -0400 Subject: [PATCH] Updates about ARM support, dependency listing, and formatting/wording --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 604f103..5454801 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # docker-autocompose -Generates a docker-compose yaml definition from a running container. +Generates a docker-compose yaml definition from a docker container. Required Modules: -* [pyaml](https://pypi.python.org/pypi/pyaml/) -* [docker](https://pypi.python.org/pypi/docker) +* [pyaml](https://pypi.python.org/project/pyaml/) +* [docker](https://pypi.python.org/project/docker) +* [six](https://pypi.python.org/project/six) Example Usage: @@ -32,13 +33,13 @@ With this tool, I can easily generate docker-compose files for managing the cont ## Docker Usage -You can use this tool from a docker container without installing it locally by either building it or using the [automated build on dockerhub.](https://hub.docker.com/r/red5d/docker-autocompose/) +You can use this tool from a docker container by either cloning this repo and building the image or using the [automatically generated image on GitHub](https://github.com/Red5d/docker-autocompose/pkgs/container/docker-autocompose) -Build the container by running: +Pull the image from GitHub (supports both x86 and ARM) - docker build -t red5d/docker-autocompose . + docker pull ghcr.io/red5d/docker-autocompose:latest Use the new image to generate a docker-compose file from a running container or a list of space-separated container names or ids: - docker run --rm -v /var/run/docker.sock:/var/run/docker.sock red5d/docker-autocompose ... + docker run --rm -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/red5d/docker-autocompose ...