From 829d87cdd516480b8ffc1f52b2f46afa9826d925 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Fri, 29 Dec 2023 17:24:34 +0100 Subject: [PATCH] Update readme --- README.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8b7633c..a0cadad 100644 --- a/README.md +++ b/README.md @@ -9,27 +9,6 @@ features: Visit documentation here: https://providers.docs.movie-web.app/ -## Development -To make testing scrapers easier during development a CLI tool is available to run specific sources. To run the CLI testing tool, use `npm run cli`. The script supports 2 execution modes +## How to run locally or test my changes -- CLI Mode, for passing in arguments directly to the script -- Question Mode, where the script asks you questions about which source you wish to test - -The following CLI Mode arguments are available - -| Argument | Alias | Description | Default | -|---------------|--------|-------------------------------------------------------------------------|--------------| -| `--fetcher` | `-f` | Fetcher type. Either `node-fetch` or `native` | `node-fetch` | -| `--source-id` | `-sid` | Source ID for the source to be tested | | -| `--tmdb-id` | `-tid` | TMDB ID for the media to scrape. Only used if source is a provider | | -| `--type` | `-t` | Media type. Either `movie` or `show`. Only used if source is a provider | `movie` | -| `--season` | `-s` | Season number. Only used if type is `show` | `0` | -| `--episode` | `-e` | Episode number. Only used if type is `show` | `0` | -| `--url` | `-u` | URL to a video embed. Only used if source is an embed | | -| `--help` | `-h` | Shows help for the command arguments | | - -Example testing the FlixHQ source on the movie "Spirited Away" - -```bash -npm run cli -- -sid flixhq -tid 129 -t movie -``` +These topics are also covered in the documentation, [read about it here](https://providers.docs.movie-web.app/extra-topics/development).