diff --git a/README.md b/README.md index a11875c..90e381a 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# transatlanticTorrentExpress \ No newline at end of file +# 🚅 Transatlantic Torrent Express +> Agent for transporting files from remote host. + +## Install +Download repo: + +```bash +git clone https://github.com/kevinmidboe/transatlanticTorrentExpress +cd transatlanticTorrentExpress +``` + +Also setup to require [delugeClient](https://github.com/KevinMidboe/delugeClient) to remove after transfered. Install the package using pip command: +```bash +pip3 install delugeClient-kevin +``` + +## Configure +Create copy of config and edit following values: + +```bash +cp config.ini.default config.ini +``` + +```ini +[SSH] +host= +user= + +[FILES] +remote= +local= + +[ELASTIC] +host= +port= +``` + +## Run + +```bash +python3 src/transatlanticTorrentExpress.py +``` \ No newline at end of file