diff --git a/README.md b/README.md index e44e65d..a673862 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# qBittorrent-YGGtracker-Search-Plugin -YGGtracker Search Plugin for qBittorrent +# YGGtracker Search Plugin for qBittorrent + +Multi-node search plugin for [qBittorrent](https://github.com/qbittorrent/qBittorrent/) + +Pay attention, the [Yggdrasil](https://github.com/yggdrasil-network/yggdrasil-go) instance required to receive search results from `0200::/7` resources! + +### Compatibility + +* qBittorrent 4^ +* qBittorrent 5 (Alpha) + +### Installation + +* View - Search Engine - Enable +* Search Tab - Search plugins - Install new one - Import from Web link +* `https://raw.githubusercontent.com/YGGverse/qbittorrent-yggtracker-search-plugin/main/yggtracker.py` + +### Nodes + +Feel free to add new YGGtracker node to the search providers in [nodes.js](https://github.com/YGGverse/qbittorrent-yggtracker-search-plugin/blob/main/nodes.json) + +### License + +* Sources - [MIT](https://github.com/YGGverse/qbittorrent-yggtracker-search-plugin/blob/main/LICENSE) \ No newline at end of file