From 753749c0681e1a07949168035b6c80113154265b Mon Sep 17 00:00:00 2001 From: Alexander Bocken Date: Sat, 29 May 2021 16:30:05 +0200 Subject: [PATCH] rough explanation added --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6445e4..f41dba2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # threadwatcher -Download media from 4chan threads realiably via a simple bash script +A simple bash script to watch over currently running threads and downloads new media with appropriate names. +MD5 checks are implemented to safe-guard against corrupted files. + +This script relies mainly on `dmenu` for interactions. + +```sh +threadwatcher [add URL DL_LOCATION] [list] [edit] [clean] + +add URL DL_LOCATION + downloads specified thread to given locaton. Paths can be relative to HOME or absolute. +list + lists all currently watched URLs and where they are downloading to +edit + open threads file in $EDITOR/vim to manually edit error +clean + deletes threads file. This will not delete already downloaded material. +``` + +## Requirements +Besides the obvious stuff for shell scripts like `sed`,`awk`,`grep` and other base-devel programs, this script relies on `jq` and, of course, `dmenu`. +Make sure these programs are installed.