diff --git a/Definition-format.md b/Definition-format.md index 0d21a80..e8badb3 100644 --- a/Definition-format.md +++ b/Definition-format.md @@ -13,7 +13,7 @@ In general, using cardigann definitions is the preferred way of adding new index # Schema -To help you conform to YML coding standards, (and maintain compatibility parity with the v9 Prowlarr yaml indexers), you can validate your Jackett yaml Indexer by using the npm ajv tool. +To help you conform to YML coding standards, (and maintain compatibility parity with the v10 Prowlarr yaml indexers), you can validate your Jackett yaml Indexer by using the npm ajv tool. ## Installation The following npm packages are required `ajv-cli-servarr ajv-formats`. @@ -40,9 +40,15 @@ Each definition must start with a header like this: # web site, in lower case, stripped of any special characters and space id: thepiratebay -# [REQUIRED] Display name (The full name of the tracker) +# [REQUIRED] Display name (The full name of the tracker) name: The Pirate Bay +# [OPTIONAL] This is an administrative function which should not be used by the end user. +# It is used to maintain backward compatibility when renaming the id of an indexer +# (the id is used in the torznab/download/search urls and in the indexer configuration file) +replaces: + - tpb-original + # [REQUIRED] displayed in the tooltip on the add-indexer page and in the config panel description: "Pirate Bay (TPB) is the galaxy’s most resilient Public BitTorrent site"