diff --git a/README.md b/README.md index 177b638..045c4b9 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,32 @@ Every other package used is included in Python 3.8+ -#### Available filter list +### Usage +This program works in two separate ways, the automatic mode and the manual mode. The automatic requires the insertion of the thread URL, while the manual requires the insertion of the thread link (mandatory) and the download path, respectively. +**Auto mode** +
+This is the default mode, and it is the easiest to use. Just run the program with the thread link and download_path. The program will automatically download the files in the thread, according to your filters. +
+```commandline +python Fscrapper.py thread_link download_path +``` -### Usage +**Manual mode** +
+Make sure to use the `-m` flag to enable the manual mode. Followed by the thread link and the download path. +
+Using manual mode, you may decide (or not) to insert minimum and maximum resolution filters for the downloaded files. +
- ``` -### Optional features +```commandline +python Fscrapper.py -m thread_link download_path --min-res x y --max-res x y +``` -### Disclaimer - -### Example +> More implementations are planned for the future, they will expand the difference between the two modes. +### Disclaimer +This program is intended for educational purposes only. I am not responsible for any misuse of this program. -###### v1.2 - CLI options - stable. +###### v2.0 - Flow refactoring