doc(trackers): documentation about how write own strategy
This commit is contained in:
parent
e932cf5e4b
commit
b7c0105cfc
@ -38,6 +38,8 @@ We are welcome any contributing: bug fixes, improvements, code refactoring and o
|
||||
|
||||
[Translation guide](docs/TRANSLATION.md)
|
||||
|
||||
[Own strategy / Other tracker support](docs/TRACKERS.md)
|
||||
|
||||
## Usage Manuals
|
||||
* [English](docs/USAGE.md)
|
||||
* [Russian](docs/USAGE.RU.md)
|
||||
|
36
docs/TRACKERS.md
Normal file
36
docs/TRACKERS.md
Normal file
@ -0,0 +1,36 @@
|
||||
## Implementation own tracker strategy
|
||||
|
||||
In a case you wanna add support of getting description from any web tracker, here the instruction:
|
||||
|
||||
## Strategy implementation
|
||||
|
||||
You need to create folowing files:
|
||||
|
||||
1. src/background/strategies/`newStrategy`.js (your strategy implementation) - [Examples](../src/background/strategies)
|
||||
2. tests/strategies/`newStrategy`.js (test for your strategy) - [Examples](../tests/strategies)
|
||||
|
||||
You need to implements follwing methods:
|
||||
|
||||
* `get name()` - Name of the strategy
|
||||
* `async findHash()` - Return object of respoce type
|
||||
* * Example of respoce object:
|
||||
```json
|
||||
{
|
||||
name: 'Name of torrent',
|
||||
poster: 'Link to poster of torrent',
|
||||
description: 'Description of torrent in text format.',
|
||||
contentCategory: 'Category of torrent'
|
||||
... Other additional files
|
||||
}
|
||||
```
|
||||
|
||||
## Client modification:
|
||||
|
||||
Add post to `app/trackers-images.js`:
|
||||
```javascript
|
||||
{
|
||||
info.trackers.includes('1337x')
|
||||
&&
|
||||
<a href={`https://example.com/${info.yourFiledForLink}`}><img src='list to image' style={{height: 32}} /></a>
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user