Add README

This commit is contained in:
MisterDaneel 2019-02-16 20:09:54 +01:00
parent 1d7385e6d4
commit 8dfd3f3cae

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Ratio.py
Ratio.py is a small command line RatioMaster.Net like in Python3. It fakes upload stats of a torrent.
Current emulators available are:
* Transmission 2.92
## Requirements:
1. Python 3.x
2. pip install -r requirements.txt
## Usage:
```console
foo@bar:~/ratio.py$ python ratio.py -c configuration.json
```
## Configuration example
```js
{
"torrent": "<Torrent file path>",
"upload": "<Upload speed (kB/s)>"
}
```