Commit 034dd3b4 authored by Yannick Kirschhoffer's avatar Yannick Kirschhoffer

Update documentation based on recent changes.

parent 78e64d4f
......@@ -9,6 +9,7 @@ A set of python scripts displaying the local docker containers structure and sta
* python 3.5
* docker-py
* termcolor
## Install
......@@ -17,20 +18,32 @@ You can install this tool from PyPI:
```
alcibiade@mobydick:~$ sudo pip3 install docker-ascii-map
Collecting docker-ascii-map
Downloading docker-ascii-map-0.3.tar.gz
Downloading docker-ascii-map-0.4.1.tar.gz
Installing collected packages: docker-ascii-map
Running setup.py install for docker-ascii-map ... done
Successfully installed docker-ascii-map-0.3
Successfully installed docker-ascii-map-0.4.1
```
## Usage
```
usage: docker-ascii-map [-h] [-v] [-c] [-m]
Display the docker host contents on a visual map.
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-c, --color Use color in map display
-m, --mono Render the map in monochrome
```
Below is a sample of a host running several applications on multiple networks.
A container is routing traffic to these networks from the host.
```
alcibiade@mobydick:~/docker-ascii-map$ docker-ascii-map.py
alcibiade@mobydick:~/docker-ascii-map$ docker-ascii-map
+- chesscorp_default ----------------+
| [✓] chesscorp_web_1 |
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment