Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README improve - what this script is actually doing #34

Open
slrslr opened this issue Feb 29, 2024 · 0 comments
Open

README improve - what this script is actually doing #34

slrslr opened this issue Feb 29, 2024 · 0 comments

Comments

@slrslr
Copy link

slrslr commented Feb 29, 2024

For the newcomers would be handy to update README and into a upper part of it describe what this script is actually doing.

It is possibly mentioned in README:

seedcross will start to:

load the torrents from the download client.
parse the name to get the title,year,episode etc, with these keyword ask Jackett server to search torrents in your pre-configured trackers.
check if there's match by title and size.
add the download link to the download client, in paused state, you will need to 'force recheck' in qBittorrent to scan the files and start seeding.
and Yes, if the configuration haven't been set, it will redirect to the Settings page.

but it is too deep in README, impractically mentioned way below the installation steps. But you usually decide whether to install something after you know what it exactly do for you.

Btw. Docker is not a requirement as you claim in README, because "Install with source" does not require it IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant