Create README.md

This commit is contained in:
Jonny007-MKD 2015-03-12 21:32:12 +01:00
parent 534035c52f
commit 3d8dd7d3b6
1 changed files with 14 additions and 0 deletions

14
README.md Normal file
View File

@ -0,0 +1,14 @@
# Torrent-Label-DB
A text database which contains torrent names and labels
This DB is used by Jonny007-MKD/OTR-DecodeAll to retreive labels set in the Torrent client by the filename.
An entry is added by the torrent client by calling a special script after adding the torrent.
The refresh script walks through all entries and fetches the label from the torrent client.
Supported torrent clients:
- Deluge (http://deluge-torrent.org/). Call `delugeAddTorrent.sh` with Action `Torrent Added` in Plugin `Execute`
- I'd love to add more clients. Please participate!
Possible problems:
- It works for single file torrents. Something else was not tested.