X-Git-Url: https://code.delx.au/webdl/blobdiff_plain/70f6f85e184c7cb59d1cd6031973373b0f65cf8f..7614fed5ca660446a173de6a1cfb8d417bd6db0d:/README.md

diff --git a/README.md b/README.md
index bfa3564..ac6de82 100644
--- a/README.md
+++ b/README.md
@@ -2,35 +2,78 @@
 
 WebDL is a set of Python scripts to grab video from online Free To Air Australian channels.
 
-## Requirements
 
-* [Livestreamer](http://docs.livestreamer.io/install.html)
-* python 2.7 or 3.2+
-* pycrypto -- Livestreamer needs this for some videos
-* python-lxml
-* ffmpeg / libav-tools
+## News
 
-## Installation
+### 2018-02-24
 
-### Arch Linux
-    pacman -S livestreamer python-crypto python-lxml ffmpeg
+* Support for Streamlink in addition to Livestreamer.
+* Currently working with iView, SBS and Channel 10.
 
-### Ubuntu
-    apt-get install livestreamer python-crypto python-lxml libav-tools
+### 2017-02-24
+* Now requires Python3, use the `python2` branch if you need the old version.
+* Recommended installation is now with `virtualenv` and `pip` to install dependencies.
+* Removed some custom logic in favour of the `requests` and `requests_cache` libraries.
+* `autograbber.py` can write to multiple directories, previous command line args are still supported.
 
-### Mac OS X
 
-Warning, this is untested!
+## Updating to the latest version
 
-    brew install python3 ffmpeg
-    pip3 install livestreamer pycrypto lxml
+You must use [git](https://git-scm.com) to keep up to date. The `autograbber-cron.sh` script is how I do this. If you'd like to manually update just run these commands.
 
-### Then get WebDL itself
-    git clone https://bitbucket.org/delx/webdl
-    cd webdl
-    python3 ./grabber.py
+```
+cd webdl
+git pull --ff-only
+```
+
+
+## Installation using pip
+
+Install the following packages using your package manager:
+
+* Python 3.2+ (including dev package)
+* ffmpeg or libav-tools
+
+Clone the WebDL repository:
+```
+git clone https://bitbucket.org/delx/webdl
+cd webdl
+```
+
+Set up a Python virtualenv and use pip to install the other dependencies:
+```
+virtualenv --python python3 .virtualenv
+. .virtualenv/bin/activate
+pip install -r requirements.txt
+```
+
+Whenever you want to run WebDL you must source the `.virtualenv/bin/activate` script from your shell.
+
+
+## Installation on Debian/Ubuntu
+
+Clone the WebDL repository:
+```
+git clone https://bitbucket.org/delx/webdl
+cd webdl
+```
+
+Install Python 3 and needed libraries:
+```
+apt-get install python3 python3-lxml python3-requests python3-requests-cache
+```
+
+You must also install Streamlink, or if it unavailable, the older Livestreamer. Depending on the age of your distro you'll need either:
+
+- `apt-get install streamlink`
+- `apt-get install livestreamer python-crypto`
 
 
+Install ffmpeg:
+```
+apt-get install ffmpeg
+```
+
 ## Interactive usage (grabber.py)
 
 You can run WebDL interactively to browse categories and episode lists and download TV episodes.
@@ -70,21 +113,28 @@ The bolded parts are what you type. Note that you can go back on any screen by t
 
 ## Cron scripted usage (autograbber.py)
 
-I have a shell script which looks something like this, I run it daily from crontab.
+You can schedule a regular download of your favourite shows. This example uses `chronic` from `moreutils`.
 
 ```
 # m    h  dom mon dow   command
-  0    1   *   *   *     ./autograbber.py /path/to/video-dir/ /path/to/patterns.txt
+  0    1   *   *   *     timeout 6h chronic $HOME/webdl/autograbber-cron.sh /videos/ABC4Kids /videos/Insight
+```
+
+Each of these directories should contain a `.patterns.txt` with shell-style globs:
+
+```
+ABC iView/By Channel/ABC4Kids/*/*
+SBS/Channel/SBS1/Insight*
 ```
 
-The patterns.txt file should contain shell-style globs, something like:
+You may optionally created a `.excludes.txt` file with shell-style globs. This is matched against the episode title and can be used to filter out things you don't want. For example:
 
 ```
-ABC iView/*/QI*/*
-SBS/Programs/Documentary/*/*
+*(Mandarin)*
+*(Chinese)*
 ```
 
-The above will download all episodes of QI from ABC as well as every SBS documentary. Whenever an episode is downloaded it is recorded into downloaded_auto.txt. Even if you move the files somewhere else they will not be redownloaded.
+Whenever an episode is downloaded it is recorded into `.downloaded_auto.txt`. Even if you move the files somewhere else they will not be redownloaded.
 
 
 ## Bug reports