From 9c734c522dbbecde215d6956cda32bd4e9694845 Mon Sep 17 00:00:00 2001 From: Franck FERMAN Date: Thu, 19 Oct 2023 04:03:16 +0200 Subject: [PATCH] Modification of export section. --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f1e464d..5a0298a 100644 --- a/README.md +++ b/README.md @@ -208,23 +208,33 @@ python3 MetaDetective.py -display all -format concise **Export Options** -For users seeking to export their results for in-depth analysis or record-keeping, the -e or --export option is available. +The -e or --export option provides the ability to export your metadata results. This can be useful for further analysis, sharing, or for maintaining a record of your findings. -To export using the default filename combined with an auto-generated timestamp: +The default export format is PDF. However, for those who have a preference or specific need, we also offer the option to export in TXT format. + +- PDF Export (Default): + +Execute the following command for a default export: ```bash python3 MetaDetective.py -d directory -e ``` -For a customized filename, simply provide the desired name after the --export or -e flag: +This command will generate a PDF file with the naming pattern: MetaDetective_Export-.pdf. + +- TXT Format Export: + +If you want your results in TXT format, append the desired format after the --export or -e flag: ```bash -python3 MetaDetective.py -d directory --export MD_Export-Case_1.html +python3 MetaDetective.py -d directory --export=txt ``` +Keep in mind that the export format can affect the presentation and usability of the data. Make sure to select the format that aligns with your intended use or preference. +

(🔼 Back to top)

## 🐳 Docker Integration -MetaDetective now offers a Dockerized version for easy setup and consistent execution. +MetaDetective offers a Dockerized version for easy setup and consistent execution. To set up and use MetaDetective with Docker, refer to the Docker-specific documentation available here: [MetaDetective Docker Setup](https://github.com/franckferman/MetaDetective/blob/stable/docker/README.md).