add-cli-demo-to-docs

README.md

@@ -1,5 +1,47 @@
+<style>
+    .container {
+        display: flex;
+        align-items: center;
+        justify-content: center;
+    }
+    .badge {
+        margin-right: 20px;
+    }
+    .image {
+        max-width: 50%;
+        height: auto;
+    }
+    .container-image {
+        display: flex;
+        justify-content: center;
+    }
+</style>
 # PostQL
 
+<div class="container container-image">
+    <img class="image" src="assets/postql.png" alt="postql">
+</div>
+
+<div class="container">
+    <div class="badge">
+        <a href="https://github.com/abeltavares/postql">
+            <img src="https://img.shields.io/badge/GitHub-Repository-blue?logo=github" alt="GitHub Repository">
+        </a>
+    </div>
+    <div class="badge">
+        <a href="https://pypi.org/project/PostQL/">
+            <img src="https://img.shields.io/pypi/v/PostQL" alt="PyPI">
+        </a>
+    </div>
+    <div class="badge">
+        <a href="https://opensource.org/licenses/MIT">
+            <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+        </a>
+    </div>
+</div>
+
+<br>
+
 PostQL is a Python library and command-line interface (CLI) tool for managing PostgreSQL databases, executing queries, exporting data and interacting with PostgreSQL databases from the command line.
 
 ## Features
@@ -34,6 +76,9 @@ my_database> Select * from my_table
 exit
 
 ```
+
+![demo](assets/postql.gif)
+
 ### Python Library
 
 ```python
@@ -93,8 +138,8 @@ db.disconnect()
 
 ## Documentation
 
-- [Methods Documentation](https://abeltavares.github.io/PostQL/methods.html)
-- [CLI Documentation](https://abeltavares.github.io/PostQL/cli.html)
+- [Methods Documentation](docs/methods.md)
+- [CLI Documentation](docs/cli.md)
 
 ## Contributing