chg: [doc] add overview

CIRCL · Apr 25, 2024 · 26f9e84 · 26f9e84
1 parent 42ef6fb
commit 26f9e84
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 0 deletions.
diff --git a/HOWTO.md b/HOWTO.md
@@ -29,6 +29,8 @@ Contributions are welcome! Fork the repository, experiment with the code, and su
 
 AIL supports crawling of websites and Tor hidden services. Ensure your Tor client's proxy configuration is correct, especially the SOCKS5 proxy settings.
 
+![Crawler](./doc/screenshots/ail-lacus.png?raw=true "AIL framework Crawler")
+
 ### Installation
 
 [Install Lacus](https://github.com/ail-project/lacus)

diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ AIL framework - Framework for Analysis of Information Leaks
 
 AIL is a modular framework to analyse potential information leaks from unstructured data sources like pastes from Pastebin or similar services or unstructured data streams. AIL framework is flexible and can be extended to support other functionalities to mine or process sensitive information (e.g. data leak prevention).
 
+![Overview](./doc/screenshots/ail-overview.png?raw=true "AIL framework Overview")
+
 ![Dashboard](./doc/screenshots/dashboard0.png?raw=true "AIL framework dashboard")
 
 
@@ -55,6 +57,8 @@ Allow easy creation and customization by extending an abstract class.
 
 ## Features
 
+![Internal](./doc/screenshots/ail-internal.png?raw=true "AIL framework Internal")
+
 - Modular architecture to handle streams of unstructured or structured information
 - Default support for external ZMQ feeds, such as provided by CIRCL or other providers
 - Multiple Importers and feeds support

diff --git a/doc/screenshots/ail-internal.png b/doc/screenshots/ail-internal.png
diff --git a/doc/screenshots/ail-lacus.png b/doc/screenshots/ail-lacus.png
diff --git a/doc/screenshots/ail-overview.png b/doc/screenshots/ail-overview.png