diff --git a/README.md b/README.md index a73a047..10ba5ae 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ # :tv: kisskh-dl -Simple downloaded for https://kisskh.me/ +
--- -## :inbox_tray: Installation +👋 Welcome to the kisskh-downloader README! This package is a simple command-line tool for downloading shows from https://kisskh.me/. Here's everything you need to know to get started: + +## 💻 Installation + +To install kisskh-downloader, simply run the following command: ```console pip install -U kisskh-downloader ``` -## :books: Usage +## 📚 Usage + +After installing the package, you can use the `kisskh dl` command to download shows from the command line. ```console kisskh dl --help @@ -27,16 +43,21 @@ Options: --help Show this message and exit. ``` -### :high_brightness: Direct download entire series in highest quality available +Here are some examples: + +### 🔗 Direct download entire series in highest quality available in current folder ```console -kisskh dl "https://kisskh.me/Drama/Money-Heist--Korea---Joint-Economic-Area?id=5044" +kisskh dl "https://kisskh.me/Drama/Island-Season-2?id=7000" -o . ``` -### :mag_right: Search and download entire series in highest quality available + + + +### 🔍 Search and download entire series in highest quality available in current folder ```console -kisskh dl "Stranger Things" +kisskh dl "Stranger Things" -o . 1. Stranger Things - Season 4 2. Stranger Things - Season 1 3. Stranger Things - Season 2 @@ -44,25 +65,40 @@ kisskh dl "Stranger Things" Please select one from above: 1 ``` -### :arrow_forward: Download specific episodes with specific quality + + +### ⬇️ Download specific episodes with specific quality > :exclamation: Note that if the selected quality is not available, it will try to get something lower than that quality. If that also is not available, it will try to get the best quality available. Downloads episode 4 to 8 of `Alchemy of Souls` in 720p: ```console -kisskh dl "https://kisskh.me/Drama/Alchemy-of-Souls?id=5043" -f 4 -l 8 -q 720p +kisskh dl "https://kisskh.me/Drama/Alchemy-of-Souls?id=5043" -f 4 -l 8 -q 720p -o . ``` + + Downloads episode 3 of `A Business Proposal` in 720p: ```console -kisskh dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p +kisskh dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p -o . ``` + + +You can also dowload single episode by providing the episode URL + +```console +kisskh dl "https://kisskh.me/Drama/A-Business-Proposal/Episode-3?id=4608&ep=86439&page=0&pageSize=100" -o . +``` + +For more options, use the `--help` flag. + --- -# :beetle: DEBUG +# 🐞 DEBUG + +To enable debugging, use the `-vv` flag while running `kisskh dl`. -Use -vv flag while running `kisskh dl` ```console kisskh -vv dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p ```