From a12e6c23b4544352d1bb3b5bb545b1af97d28434 Mon Sep 17 00:00:00 2001
From: Hassan Abedi <hassan.abedi.t@gmail.com>
Date: Mon, 21 Oct 2024 22:09:55 +0200
Subject: [PATCH] Add documentation

* Added example code snippets
* Added a few document entries
* Added a demo of the CLI use
* Updated the version
---
 .gitignore                          | 1 +
 README.md                           | 6 +++++-
 assets/{logo_v1.png => logo-v1.png} | 0
 assets/{logo_v2.png => logo-v2.png} | 0
 pyproject.toml                      | 2 +-
 5 files changed, 7 insertions(+), 2 deletions(-)
 rename assets/{logo_v1.png => logo-v1.png} (100%)
 rename assets/{logo_v2.png => logo-v2.png} (100%)

diff --git a/.gitignore b/.gitignore
index 263aca2..9108cbb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -79,3 +79,4 @@ poetry.lock
 *.gz
 *.xlsx
 *.zip
+*.cast
diff --git a/README.md b/README.md
index 6ae912f..e287122 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Mongo Analyser
 
-<img src="assets/logo_v1.png" align="right" width="25%"/>
+<img src="assets/logo-v1.png" align="right" width="25%"/>
 
 [![Tests](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/habedi/mongo-analyser/graph/badge.svg?token=HOTAZKP3V7)](https://codecov.io/gh/habedi/mongo-analyser)
@@ -39,3 +39,7 @@ After the installation is complete, you can use the `mongo-analyser` command in
 
 See the [documentation](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md) for more information and
 examples.
+
+## Demo
+
+[![asciicast](https://asciinema.org/a/682346.svg)](https://asciinema.org/a/682346)
diff --git a/assets/logo_v1.png b/assets/logo-v1.png
similarity index 100%
rename from assets/logo_v1.png
rename to assets/logo-v1.png
diff --git a/assets/logo_v2.png b/assets/logo-v2.png
similarity index 100%
rename from assets/logo_v2.png
rename to assets/logo-v2.png
diff --git a/pyproject.toml b/pyproject.toml
index f92f73f..97ea7db 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mongo-analyser"
-version = "0.1.4"
+version = "0.1.5"
 description = "A minimalistic tool for analysing and extracting the schema of a MongoDB collection."
 authors = ["Hassan Abedi <hassan.abedi.t@gmail.com>"]
 maintainers = ["Hassan Abedi <hassan.abedi.t@gmail.com>"]