From f696410a871d863c44fe40553e8019ab258018c7 Mon Sep 17 00:00:00 2001
From: BlyDoesCoding <brueggemann.l@proton.me>
Date: Mon, 20 Mar 2023 20:51:50 +0100
Subject: [PATCH] Rework of README.md

---
 .idea/workspace.xml | 37 ++++++++++++++++++++++---------------
 README.md           | 16 ++++++++++++++--
 2 files changed, 36 insertions(+), 17 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index d2c0e93..3334759 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -11,7 +11,7 @@
   <component name="ChangeListManager">
     <list default="true" id="9b57ac51-c870-474b-9dfd-64a5fc490635" name="Changes" comment="Added -h / -help option for better usability">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/Main.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/Main.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -41,8 +41,8 @@
   <component name="GithubPullRequestsUISettings">
     <option name="selectedUrlAndAccountId">
       <UrlAndAccount>
-        <option name="accountId" value="614b6e79-2a1d-40ca-82ec-6c7ae06c9284" />
-        <option name="url" value="https://github.com/bly-codes/Sherly.git" />
+        <option name="accountId" value="1ec83841-9eac-4bec-b8b8-e821355f624e" />
+        <option name="url" value="https://github.com/BlyDoesCoding/Sherly.git" />
       </UrlAndAccount>
     </option>
   </component>
@@ -55,18 +55,18 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "RunOnceActivity.OpenProjectViewOnStart": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
-    "last_opened_file_path": "/home/bly/IdeaProjects/Sherly",
-    "project.structure.last.edited": "Artifacts",
-    "project.structure.proportion": "0.15",
-    "project.structure.side.proportion": "0.2",
-    "settings.editor.selected.configurable": "vcs.Git"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/home/bly/IdeaProjects/Sherly&quot;,
+    &quot;project.structure.last.edited&quot;: &quot;Artifacts&quot;,
+    &quot;project.structure.proportion&quot;: &quot;0.15&quot;,
+    &quot;project.structure.side.proportion&quot;: &quot;0.2&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;vcs.Git&quot;
   }
-}]]></component>
+}</component>
   <component name="RunAnythingCache">
     <option name="myCommands">
       <command value="github" />
@@ -187,7 +187,14 @@
       <option name="project" value="LOCAL" />
       <updated>1674655881410</updated>
     </task>
-    <option name="localTasksCounter" value="14" />
+    <task id="LOCAL-00014" summary="Added -h / -help option for better usability">
+      <created>1679341241426</created>
+      <option name="number" value="00014" />
+      <option name="presentableId" value="LOCAL-00014" />
+      <option name="project" value="LOCAL" />
+      <updated>1679341241426</updated>
+    </task>
+    <option name="localTasksCounter" value="15" />
     <servers />
   </component>
   <component name="Vcs.Log.Tabs.Properties">
diff --git a/README.md b/README.md
index 8efc03c..82cc20e 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,17 @@
 ## Introduction
 Sherly is a Multithreaded Duplicate File Finder for your Terminal, written in java. You can Easily find duplicate Images, videos as well as any other type of Data. That can be helpful if you run on small storage or just want to keep regular housekeeping.
 
-## Screenshots
-![screenshot](https://github.com/BlyDoesCoding/Sherly/blob/master/Images/screenshot?raw=true)
+## Full Usages
+```console
+Usage: sherly -f inputfolder1 inputfolder2 inputfolder3 [options]...
+ 
+   -h / -help             show this
+   -f / -folder           all the folders you want to scan for (see example above!)
+   -c / -color            enable colored messages
+   -p / -progress         enable progress indicator
+   -d / -delete           delete all found duplicates except one
+   -debug                 debug stuff
+```
 
 ## Supported Platforms
 
@@ -15,3 +24,6 @@ Sherly is a Multithreaded Duplicate File Finder for your Terminal, written in ja
 | Linux             | Yes       | 1.1.1   |
 | Windows 10/11/8/7 | Yes       | 1.1.1   |
 | BSD               | TBD       | X       |
+
+## Screenshots
+![screenshot](https://github.com/BlyDoesCoding/Sherly/blob/master/Images/screenshot?raw=true)