diff --git a/README.md b/README.md index 5a8ef4d..86e9d10 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,43 @@ -# Hentai Downloader +# Hentai Cosplay Downloader -## Requirements +This makes it easier for you to download files from [hentai-cosplays.com](https://hentai-cosplays.com/) without having to do it one by one, and you don't have to remember your +download progress because we will take care of it. -- SQLite3 -- PHP 8.1 with curl, sqlite3, and mbstring extensions +> **Warning** +> +> This package may contain pornographic content, by using this package you agree that we and the [contributors](https://github.com/SupianIDz/HentaiCosplay/graphs/contributors) will not be responsible for any problems caused by this application. ## Installation +Please make sure you have the following requirements installed below: + +- SQLite3 +- PHP 8.1 with curl, sqlite3, and mbstring extensions + Download the latest release from the [releases page](https://github.com/SupianIDz/HentaiCosplay/releases). ## Usage +First you need to initialize the database by running the following command. + ```bash -php hentai +php hentai app:init ``` - - ### Crawl URLs -First, you need to crawl the URLs from the website. You can crawl a single URL using the following command. +You need to crawl the URLs from the website. You can crawl a single URL using the following command. ```bash php hentai img:crawl https://hentai-cosplays.com/image/coserpingping-misa-amane/ ``` - - or you can crawl multiple URLs at once using a text file containing the URLs line by line. ```bash -php hentai img:crawl source.txt +php hentai img:crawl ./source.txt ``` - - ### Getting Images After crawling the URLs, you can download the images using the following command. @@ -50,3 +53,12 @@ or you can set the download directory by adding output directory as the second a ```bash php hentai img:fetch ~/output/ ``` + +## Credits + +- [Supian M](https://github.com/SupianIDz) +- [Octopy ID](https://github.com/OctopyID) + +## License + +The MIT License (MIT). Please see [License File](LICENSE) for more information. diff --git a/examples/1.png b/examples/1.png deleted file mode 100644 index d92a799..0000000 Binary files a/examples/1.png and /dev/null differ diff --git a/examples/2.png b/examples/2.png deleted file mode 100644 index 3d7aa3e..0000000 Binary files a/examples/2.png and /dev/null differ diff --git a/examples/3.png b/examples/3.png deleted file mode 100644 index caab848..0000000 Binary files a/examples/3.png and /dev/null differ