From 16006e697e0ae77ae16de05fc1c699454f3c7b2e Mon Sep 17 00:00:00 2001
From: YooSunyoung <luysunyoung9@gmail.com>
Date: Mon, 4 Nov 2024 10:49:25 +0100
Subject: [PATCH] Update how to use section.

---
 README.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 840922f..54340f3 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ You can start the ingestor daemon with certain configurations.
 It will continuously process `wrdn` messages and ingest the nexus files.
 
 ```bash
-scicat_ingestor --verbose -c PATH_TO_CONFIGURATION_FILE.yaml
+scicat_ingestor --logging.verbose -c PATH_TO_CONFIGURATION_FILE.yaml
 ```
 
 See [configuration](#configuration) for how to use configuration files.
@@ -34,13 +34,30 @@ You need to know the path to the nexus file you want to ingest
 and also the path to the ``done_writing_message_file`` as a json file.
 
 ```bash
-background_ingestor \\
-    --verbose \\
-    -c PATH_TO_CONFIGURATION_FILE.yaml \\
-    --nexus-file PATH_TO_THE_NEXUS_FILE.nxs \\
+background_ingestor \
+    --logging.verbose \
+    -c PATH_TO_CONFIGURATION_FILE.yaml \
+    --nexus-file PATH_TO_THE_NEXUS_FILE.nxs \
     --done-writing-message-file PATH_TO_THE_MESSAGE_FILE.json
 ```
 
+### Dry run
+
+You can add ``--ingestion.dry-run`` flag for dry-run testings.
+
+```bash
+scicat_ingestor --logging.verbose -c PATH_TO_CONFIGURATION_FILE.yaml --ingestion.dry-run
+```
+
+```bash
+background_ingestor \
+    --logging.verbose \
+    -c PATH_TO_CONFIGURATION_FILE.yaml \
+    --nexus-file PATH_TO_THE_NEXUS_FILE.nxs \
+    --done-writing-message-file PATH_TO_THE_MESSAGE_FILE.json \
+    --ingestion.dry-run
+```
+
 ## Configuration
 
 You can use a json file to configure options.