AUR Package instructions

.idea/workspace.xml

@@ -9,10 +9,9 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="9b57ac51-c870-474b-9dfd-64a5fc490635" name="Changes" comment="Upload Bin">
+    <list default="true" id="9b57ac51-c870-474b-9dfd-64a5fc490635" name="Changes" comment="Prepare for Aur Package">
-      <change afterPath="$PROJECT_DIR$/src/sherly" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Bin/sherly.jar" beforeDir="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" />
@@ -36,9 +35,6 @@
       </list>
     </option>
   </component>
-  <component name="GithubDefaultAccount">
-    <option name="defaultAccountId" value="1ec83841-9eac-4bec-b8b8-e821355f624e" />
-  </component>
   <component name="GithubPullRequestsUISettings">
     <option name="selectedUrlAndAccountId">
       <UrlAndAccount>
@@ -237,7 +233,14 @@
       <option name="project" value="LOCAL" />
       <updated>1679346354129</updated>
     </task>
-    <option name="localTasksCounter" value="21" />
+    <task id="LOCAL-00021" summary="Prepare for Aur Package">
+      <created>1679415958151</created>
+      <option name="number" value="00021" />
+      <option name="presentableId" value="LOCAL-00021" />
+      <option name="project" value="LOCAL" />
+      <updated>1679415958151</updated>
+    </task>
+    <option name="localTasksCounter" value="22" />
     <servers />
   </component>
   <component name="Vcs.Log.Tabs.Properties">
@@ -279,7 +282,8 @@
     <MESSAGE value="Update README.md according to the new deletion behavior" />
     <MESSAGE value="Added -t to tell Sherly the number of Threads it should use" />
     <MESSAGE value="Upload Bin" />
-    <option name="LAST_COMMIT_MESSAGE" value="Upload Bin" />
+    <MESSAGE value="Prepare for Aur Package" />
+    <option name="LAST_COMMIT_MESSAGE" value="Prepare for Aur Package" />
   </component>
   <component name="XDebuggerManager">
     <breakpoint-manager>

README.md

@@ -17,14 +17,25 @@ Usage: sherly -f inputfolder1 inputfolder2 inputfolder3 [options]...
    -d / -delete           delete all dups except one without asking first
    -debug                 debug stuff
 ```
+## Installation
+# Via AUR for Arch users
+
+```console
+yay -S sherly-git
+#just replace yay with your aur helper of choise
+
+# Any other OS
+
+you can easily download the jar file from the releases Tab and are able to execute it with the prefix "java --jar"
+```
 
 ## Supported Platforms
 
 | OS                |    Working     | Version |
-| :----:            |:----:     |:-------:|
+| :----:            |:--------------:|:-------:|
 | Linux             |      Yes       |  1.1.2  |
 | Windows 10/11/8/7 |      Yes       |  1.1.2  |
-| BSD               | TBD       |    X    |
+| BSD               | Not yet Tested |    X    |
 
 ## Screenshots
 ![screenshot](https://github.com/BlyDoesCoding/Sherly/blob/master/Images/screenshot?raw=true)