From 1db432d5fce9c0a20d4920427ce954ff62c633df Mon Sep 17 00:00:00 2001 From: Nate Jones Date: Mon, 21 Apr 2014 21:16:20 -0700 Subject: [PATCH] update readme with current state --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 905309e..c8d842c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -dockviz -======= +# dockviz -Visualizing docker data +Visualizing Docker Data + +This command takes the raw Docker JSON and visualizes it in various ways. The +only thing that works so far is [Graphviz](http://www.graphviz.org), but others +will come. + +# Running + +Currently, this only works when the remote API is listening on TCP. Soon, the Docker command line will allow dumping the image JSON. + +``` +$ curl -s http://localhost:4243/images/json?all=1 | ./dockviz images -d > images.dot +``` + +# Download + +For now, download binaries from Gobuild: