add-cli-demo-to-docs

abeltavares · Mar 1, 2024 · dedf6a9 · dedf6a9
1 parent 77b3699
commit dedf6a9
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 # PostQL
 
+[![GitHub](https://img.shields.io/badge/GitHub-Repository-blue?logo=github)](https://github.com/abeltavares/postql)
+
+[![PyPI](https://img.shields.io/pypi/v/PostQL)](https://pypi.org/project/PostQL/)
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
 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 +41,9 @@ my_database> Select * from my_table
 exit
 
 ```
+
+![demo](assets/postql.gif)
+
 ### Python Library
 
 ```python
@@ -93,8 +103,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
 

diff --git a/assets/postql.gif b/assets/postql.gif
diff --git a/docs/index.md b/docs/index.md