Skip to content

README improve - what this script is actually doing #34

@slrslr

Description

@slrslr

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions