From a5b9e515130b9fbbf89f9d6a1108f8ec679eee1b Mon Sep 17 00:00:00 2001 From: speedyconzales <9094731+speedyconzales@users.noreply.github.com> Date: Wed, 1 May 2024 19:09:09 +0200 Subject: [PATCH] updates README --- README.md | 12 +++++++----- template.yml | 4 ++-- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e81e0ef..088bed3 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,13 @@ - [Streamtape](https://streamtape.com) ## Usage -1. if you are familiar with docker just use the following [docker-compose.yml](https://github.com/speedyconzales/series-scraper/blob/main/docker-compose.yml) file and run `docker compose up series-scraper ` in the same directory -2. if you don't want to use docker or there is no suitable docker image available for your system, you can use the following steps to run the scraper: - - clone the repository - - install the dependencies - - run the scraper `python main.py` with the provided arguments +1. if you are familiar with docker just use: + 1. `docker pull speedyconzales/series-scraper` + 2. `docker run --rm -v :/series-scraper/anime -v :/series-scraper/series speedyconzales/series-scraper` followed by the arguments you want to provide +2. if you don't want to use docker or there is no suitable docker image available for your architecture, you can use the following steps to run the scraper: + 1. clone the repository + 2. install the dependencies + 3. run the scraper `python main.py` with the provided arguments ## Dependencies diff --git a/template.yml b/template.yml index 6cc662e..b841ab6 100644 --- a/template.yml +++ b/template.yml @@ -1,2 +1,2 @@ -anime_folder: Anime -series_folder: Series +anime_folder: anime +series_folder: series