From 5fa0c98d0579c245482cadc89fd0a459abd8704f Mon Sep 17 00:00:00 2001 From: glax Date: Fri, 9 Jun 2023 11:26:51 +0200 Subject: [PATCH] Documentation how to create tasks #11 --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index f15d2cd..c4c8aad 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@
  • Getting Started
    • @@ -109,6 +110,28 @@ Download [docker-compose.yaml](https://git.bernloehr.eu/glax/Tranga/src/branch/m Wherever you are mounting `/usr/share/Tranga-API` you also need to mount that same path + `/imageCache` in the webserver container. +### Usage + +There is two ways to download Mangas: +- Downloading everything and monitor for new Chapters +- Selecting specific Volumes/Chapters + +On the website you add new tasks, by selecting the blue '+' field. Next select the connector/site you want to use, and enter a search term. +After pressing 'Search', the results will be presented below - this might, depending on the result-size, take a while. +Next select the publication and a new popup will open with two options: +- "Monitor" - Download all chapters and monitor for new ones +- "Download Chapter" - Download specific chapters only + +When selecting `Monitor` you will be presented with a new window and the selection of the interval you want to check for new chapters. +When selecting `Download Chapter` a list will open with all available chapters from which you can then select a range. + +The syntax for selecting chapters is as follows: +- To download a single Chapter enter either the index number (the number at the very start of the line) or its absolute number like so: `c(h)(apter)[number]`, spaces are allowed. +- To download a range of chapters enter either a range of index numbers (`3-6`) or chapters (`ch 12-23`). +- For volumes the syntax is as follows: `v(ol)[number](-[number])`, again spaces allowed. + +Examples: `2-12`, `c1`, `ch 2`, `chapter 3`, `v 2`, `vol3-4`, `v2c4` (note: you can only specify a single chapter with this syntax). + ### Prerequisites [.NET-Core 7.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)