chore: Updated docs

dikayx · Aug 14, 2024 · 7208e88 · 7208e88
1 parent 893ce59
commit 7208e88
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # MAPy
 
 [![Python3](https://img.shields.io/badge/Python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
+[![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](LICENSE)
 [![Build Status](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml/badge.svg)](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml)
 
 MAPy is a small utility tool for **M**ail **A**nalysis in **Py**thon inspired by CyberDefenders' [Email-Header-Analyzer](https://github.com/cyberdefenders/email-header-analyzer). It is designed to help you parse email data and extract useful information from it.

diff --git a/assets/flow.gif b/assets/flow.gif
diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md
@@ -82,6 +82,8 @@ Message-ID: <E5-3hqyee3o-elaine/10/[email protected]
 
 The user interface of the application is divided into two main sections: the input section and the result section.
 
+![Usage](../assets/flow.gif)
+
 ### Input Section
 
 The input section is where you paste the email data you want to analyze. It consists of a text area where you can paste the email data and a button to start the analysis.