summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6512426
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# SortUnsorted
+
+This program takes a parameter for the amount of videos you would like to sort from your UNSORTEDIR. If you do not pass a paramater, it will assume that you only wish to sort one video. These videos are then moved to ~/Videos/ with a new name that you provide or deleted depending on your choice.
+
+UNSORTEDIR is a directory in ~/Videos/ named "unsorted". This directory is used to store downloaded videos you wish to sort.
+
+Dependencies: https://packages.debian.org/sid/mpv https://packages.debian.org/sid/trash-cli https://git.techchud.xyz/ipfs-archive-manager/
+
+Usage Example:
+`sortunsorted 25` Will let your sort 25 videos
+`sortunsorted` will just sort one video