From 47dc56271b11964b5c1c1bc40397c992d37e6185 Mon Sep 17 00:00:00 2001 From: Dan Wilson Date: Wed, 21 Dec 2016 10:47:43 -0700 Subject: [PATCH] Add installation instructions --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 507f088..145011c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Summary --------------- -yts-downloader is an open source project providing automatic downloading of torrents for recent movies from yts.ag. You can filter based on quality (720p, 1080p, 3D), genre, rotten tomato rating or even MPA rating. +*yts-downloader* is an open source NodeJS project providing automatic torrent downloading for recent movies published by [yts.ag](http://yts.ag). You can filter based on quality (720p, 1080p, 3D), genre, rotten tomato rating, minimum year or even MPA rating. This project will only download the torrent files. The assumption is that a separate torrent downloader utility, like [Transmission](https://transmissionbt.com), be used to download the actual movies. Transmission can watch a designated directory for new torrent files to automaticaly add the torrent files and start downloading the movies. This directory should be designated as the `destination` in the *yts-downloder* configuration file. Requirements --------------- @@ -11,7 +11,7 @@ Requirements Features --------------- -- [x] Set frequency of fetching downloads +- [x] Set frequency of fetching torrents - [x] Cache when it already examined a movie, so it doesn't try to redownload - [x] Filter by genre - [x] Filter by quality (1080p, 720p, 3D) @@ -19,9 +19,22 @@ Features - [x] Filter by MPA rating - [x] Filter by minimum year +Installation +--------------- +To use *yts-downloader*, you must first install [NodeJS](https://nodejs.org/en/download/). After Node is installed, download and unzip the latest [release](https://github.com/killroyboy/yts-downloader/releases) into any given directory. + +Customize the configuration by copying the `config/default.json` file to `config/development.json` and then editing your settings. If you edit default.json directly, it is likely that future versions of *yts-downloder* will overwrite your customizations. + +Open a command line window (`terminal` on MacOS or follow [these instructions](https://www.lifewire.com/command-prompt-2625840) for Windows) and issue the following commands within the yts-downloader directory: +- npm install +- node index.js + +The first command will install all the prerequisits and the second stars *yts-downloader*. You will need to keep this window and process running in order to allow it to continue to retrieve torrent files. There are tools available (like [forever](https://www.npmjs.com/package/forever)) to ensure the process runs in the background. + + Configuration --------------- -This is the default configuration. You can easily customize and override any setting by copying the `config/default.json` file to `config/development.json` and then change any settings you desire. +Below is the default configuration. You can easily customize and override any setting by copying the `config/default.json` file to `config/development.json` and then change any settings you desire. ```js {