Skip to content

Commit

Permalink
Merge pull request #19 from balbi-uff/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
balbi-uff authored Jan 3, 2023
2 parents d22f535 + 4933397 commit a94d204
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
<br>
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.
<br>
```commandline
python Fscrapper.py thread_link download_path
```

### Usage
**Manual mode**
<br>
Make sure to use the `-m` flag to enable the manual mode. Followed by the thread link and the download path.
<br>
Using manual mode, you may decide (or not) to insert minimum and maximum resolution filters for the downloaded files.
<br>

```
### 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

0 comments on commit a94d204

Please sign in to comment.