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

Merge pull request #16 from compose-viz/dev

Browse source 
chore: update README.md
This commit is contained in:
Xyphuz 2022-05-26 02:01:05 +08:00 committed by GitHub
commit ec30a3f25a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -40,9 +40,9 @@
<ul>
<li><a href="#prerequisities">Prerequisities</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#example">Example</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#options">Options</a></li>
<li><a href="#example">Example</a></li>
</ul>
</li>
<li><a href="#roadmap">Roadmap</a></li>
@ -82,6 +82,16 @@ If you want to generate PNG (which is the default option), you need to install [
See [releases](https://github.com/compose-viz/compose-viz/releases).
### Example
`cpv -o .\examples\full-stack-node-app\compose-viz.png .\examples\full-stack-node-app\docker-compose.yml`
And this is what the results look like:
![compose-viz.png](https://github.com/compose-viz/compose-viz/blob/main/examples/full-stack-node-app/compose-viz.png)
Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main/examples/full-stack-node-app/compose-viz.png).
### Usage
`cpv [OPTIONS] INPUT_PATH`
@ -95,12 +105,6 @@ See [releases](https://github.com/compose-viz/compose-viz/releases).
| `-v, --version` | Show the version of compose-viz. |
| `--help` | Show help and exit. |
### Example
`cpv -o .\examples\full-stack-node-app\compose-viz.png .\examples\full-stack-node-app\docker-compose.yml`
[Here](https://github.com/compose-viz/compose-viz/blob/main/examples/full-stack-node-app/compose-viz.png) is the result.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ROADMAP -->