From 25beab44e3d393d6fb8875700da542764d4d87a5 Mon Sep 17 00:00:00 2001
From: STAM <stam@epicm.org>
Date: Fri, 23 Sep 2022 18:21:13 +0300
Subject: [PATCH] readme

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index d22f550..17f6c59 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,21 @@ Options:
   -?, -h, --help                                           Show help and usage information
 ```
 
+## Example of useage:
+
+### Download or update all local archive
+```
+PS>   .\atlassian-downloader.exe --output-dir "P:\Atlassian"
+or
+bash# ./atlassian-downloader --output-dir "/mnt/nfs/atlassian"
+```
+If you already have some folders at output path, they will be ignored and not be downloaded again and skipped. Downloader will be download only new versions of files which not be present locally yet.
+
+### Show only urls from jsons
+```
+PS>   .\atlassian-downloader.exe --action ListURLsor
+bash# ./atlassian-downloader --action ListURLs
+```
 
 ## Additional settings
 File `src/appSettings.json` contains additional settings, like [loglevel](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loglevel?view=dotnet-plat-ext-5.0#fields) and [console output theme](https://github.com/serilog/serilog-sinks-console). You can set it up via editing this file.