diff --git a/README.md b/README.md index a577d14..a2009ca 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ Use `maigret --help` to get full options description. Also options [are document ![HTML report screenshot](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotography_html_screenshot.png) -![XMind report screenshot](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotography_xmind_screenshot.png) +![XMind 8 report screenshot](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotography_xmind_screenshot.png) [Full console output](https://raw.githubusercontent.com/soxoj/maigret/main/static/recursive_search.md) diff --git a/docs/source/features.rst b/docs/source/features.rst index 6367d5d..cf1dc98 100644 --- a/docs/source/features.rst +++ b/docs/source/features.rst @@ -24,7 +24,7 @@ Enabled by default, can be disabled with ``--no-recursion``. Reports ------- -Maigret currently supports HTML, PDF, TXT, XMind mindmap, and JSON reports. +Maigret currently supports HTML, PDF, TXT, XMind 8 mindmap, and JSON reports. HTML/PDF reports contain: @@ -34,6 +34,8 @@ HTML/PDF reports contain: Also, there is a short text report in the CLI output after the end of a searching phase. +**Warning**: XMind 8 mindmaps are incompatible with XMind 2022! + Tags ---- diff --git a/docs/source/philosophy.rst b/docs/source/philosophy.rst index bd53312..64a184f 100644 --- a/docs/source/philosophy.rst +++ b/docs/source/philosophy.rst @@ -3,4 +3,15 @@ Philosophy ========== -Username => Dossier +TL;DR: Username => Dossier + +Maigret is designed to gather all the available information about person by his usernname. + +What kind of information is this? First, links to person accounts. Secondly, all the machine-extractable +pieces of info, such as: other usernames, full name, URLs to people's images, birthday, location (country, +city, etc.), gender. + +All this infromations forms some dossier, but it also useful for other tools and analytical purposes. +Each collected piece of data has a label of a certain format (for exa,ple, ``follower_count`` for the number +of subscribers or ``created_at`` for account creation time) so that it can be parsed and analyzed by various +systems and stored in databases.