From ff12a0e6171df1178e1d61416cf5905254755925 Mon Sep 17 00:00:00 2001
From: Xyphuz <hansen0715.2@gmail.com>
Date: Mon, 2 May 2022 16:14:22 +0800
Subject: [PATCH] chore: init

---
 README.md | 152 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 152 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c26d37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,152 @@
+<div id="top"></div>
+
+<!-- PROJECT SHIELDS -->
+
+[<div align="center"> ![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![MIT License][license-shield]][license-url]
+[![Issues][issues-shield]][issues-url]
+[![Issues Closed][issues-closed-shield]</div>][issues-closed-url]
+
+<br />
+
+<!-- PROJECT LOGO -->
+
+![compose-viz](https://socialify.git.ci/compose-viz/compose-viz/image?description=1&font=KoHo&name=1&owner=1&pattern=Circuit%20Board&theme=Light)
+
+<br />
+<div align="center">
+<p align="center">
+    <a href="https://github.com/compose-viz/compose-viz#usage"><strong>Explore Usage »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/compose-viz/compose-viz/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/compose-viz/compose-viz/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <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>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+`compose-viz` is a [docker-compose](https://github.com/docker/compose)/[podman-compose](https://github.com/containers/podman-compose) graph visualization tool that allows you to gernerate graph in [DOT](https://graphviz.org/doc/info/lang.html) format or `.png`.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+<!-- GETTING STARTED -->
+
+## Getting Started
+
+### Usage
+
+`python3 compose-viz.py [option] [input-file]`
+
+### Options
+
+| Option                        | Necessity | Description       | Default Value   |
+| ----------------------------- | --------- | ----------------- | --------------- |
+| `-o --output-file`            | Optional  | Output file path. | `./compose.png` |
+| `-m --output-format=DOT, PNG` | Optional  | Output format.    | PNG             |
+
+### Example
+
+`python3 compose-viz.py docker-compose.yaml`
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+<!-- ROADMAP -->
+
+## Roadmap
+
+- [ ] Support [podman-compose](https://github.com/containers/podman-compose).
+
+See the [open issues](https://github.com/compose-viz/compose-viz/issues)
+for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to
+learn, inspire, and create. Any contributions you make are **greatly
+appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and
+create a pull request. You can also simply open an issue with the tag
+"enhancement". Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feat/amazing-feature`)
+3. Commit your Changes with
+   [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+4. Push to the Branch (`git push origin feat/amazing-feature`)
+5. Open a Pull Request
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+<!-- LICENSE -->
+
+## License
+
+Distributed under the MIT License. See
+[LICENSE](https://github.com/compose-viz/compose-viz/blob/main/LICENSE)
+for more information.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+<!-- CONTACT -->
+
+## Contact
+
+### Author
+
+- HSING-HAN, WU (Xyphuz)
+  - Mail me: xyphuzwu@gmail.com
+  - About me: <https://about.xyphuz.com>
+  - GitHub: <https://github.com/wst24365888>
+
+### Project Link
+
+- <https://github.com/compose-viz/compose-viz>
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+[contributors-shield]: https://img.shields.io/github/contributors/compose-viz/compose-viz.svg?style=for-the-badge
+[contributors-url]: https://github.com/compose-viz/compose-viz/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/compose-viz/compose-viz.svg?style=for-the-badge
+[forks-url]: https://github.com/compose-viz/compose-viz/network/members
+[stars-shield]: https://img.shields.io/github/stars/compose-viz/compose-viz.svg?style=for-the-badge
+[stars-url]: https://github.com/compose-viz/compose-viz/stargazers
+[issues-shield]: https://img.shields.io/github/issues/compose-viz/compose-viz.svg?style=for-the-badge
+[issues-url]: https://github.com/compose-viz/compose-viz/issues
+[issues-closed-shield]: https://img.shields.io/github/issues-closed/compose-viz/compose-viz.svg?style=for-the-badge
+[issues-closed-url]: https://github.com/compose-viz/compose-viz/issues?q=is%3Aissue+is%3Aclosed
+[license-shield]: https://img.shields.io/github/license/compose-viz/compose-viz.svg?style=for-the-badge
+[license-url]: https://github.com/compose-viz/compose-viz/blob/main/LICENSE
\ No newline at end of file