From 2f274ac00201020ce5ec48eb8ddd3be0a210379a Mon Sep 17 00:00:00 2001
From: Xyphuz <hansen0715.2@gmail.com>
Date: Sun, 15 May 2022 19:24:36 +0800
Subject: [PATCH] chore: update README.md

---
 README.md | 25 +++++++++++++++++++------
 1 file changed, 19 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 060e486..c4bd58a 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,7 @@
     <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
+        <li><a href="#installation">Installation</a></li>
         <li><a href="#usage">Usage</a></li>
         <li><a href="#options">Options</a></li>
         <li><a href="#example">Example</a></li>
@@ -62,20 +63,32 @@
 
 ## Getting Started
 
+### Installation
+
+#### Using `pip`
+
+`pip install compose-viz`
+
+#### Using `.whl`
+
+See [releases](https://github.com/compose-viz/compose-viz/releases).
+
 ### Usage
 
-`python3 compose-viz.py [OPTIONS] [input-file]`
+`cpv [OPTIONS] INPUT_PATH`
 
 ### Options
 
-| Option                        | Necessity | Description       | Default Value   |
-| ----------------------------- | --------- | ----------------- | --------------- |
-| `-o --output-file`            | Optional  | Output file path. | `./compose.png` |
-| `-m --output-format=DOT, PNG` | Optional  | Output format.    | PNG             |
+| Option                   | Description                                                                    |
+| ------------------------ | ------------------------------------------------------------------------------ |
+| `-o, --output-path`      | Output path for the generated visualization file. [default: ./compose-viz.png] |
+| `-m, --format [PNG,DOT]` | Output format for the generated visualization file. [default: PNG]             |
+| `-v, --version`          | Show the version of compose-viz.                                               |
+| `--help`                 | Show help and exit.                                                            |
 
 ### Example
 
-`python3 compose-viz.py docker-compose.yaml`
+`cpv -o docker-compose-viz.png docker-compose.yml`
 
 <p align="right">(<a href="#top">back to top</a>)</p>