simono41/compose-viz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: add Docker instructions in README.md

Browse source
This commit is contained in:
Xyphuz 2022-05-29 16:38:13 +08:00
parent cec8d6d579
commit 3eb3e8a8fe
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -82,13 +82,25 @@ You need to install [Graphviz](https://graphviz.org/download/) to generate graph
See [releases](https://github.com/compose-viz/compose-viz/releases).
#### Docker Image
See [wst24365888/compose-viz](https://hub.docker.com/r/wst24365888/compose-viz/tags).
### Example
This example yml is from [docker compose beginner tutorial](https://github.com/docker/labs/blob/master/beginner/chapters/votingapp.md).
```bash
cd examples/voting-app/
# using python script
cpv -m svg docker-compose.yml
# using docker image
docker run --rm -it -v $(pwd):/in wst24365888/compose-viz -m svg docker-compose.yml
# using docker image in powershell
docker run --rm -it -v ${pwd}:/in wst24365888/compose-viz -m svg docker-compose.yml
```
And this is what the result looks like: