X-Git-Url: https://code.delx.au/webdl/blobdiff_plain/6b6a0c8ed47c0fcbed6116c84166567b2dbf7a46..bfaf019987c47406335b61c5825cabe21cafa107:/README.md

diff --git a/README.md b/README.md
index 3b10969..ac6de82 100644
--- a/README.md
+++ b/README.md
@@ -3,15 +3,76 @@
 WebDL is a set of Python scripts to grab video from online Free To Air Australian channels.
 
 
-## Installation
+## News
 
-    git clone https://bitbucket.org/delx/webdl
-    cd webdl
-    virtualenv --python python3 .virtualenv
-    . .virtualenv/bin/activate
-    pip install -r requirements.txt
-    ./grabber.py
+### 2018-02-24
 
+* Support for Streamlink in addition to Livestreamer.
+* Currently working with iView, SBS and Channel 10.
+
+### 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.
+
+
+## Updating to the latest version
+
+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.
+
+```
+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)
 
@@ -52,11 +113,11 @@ The bolded parts are what you type. Note that you can go back on any screen by t
 
 ## Cron scripted usage (autograbber.py)
 
-You can schedule a regular download of your favourite shows.
+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 /videos/ABC4Kids /videos/Insight
+  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:
@@ -66,6 +127,13 @@ ABC iView/By Channel/ABC4Kids/*/*
 SBS/Channel/SBS1/Insight*
 ```
 
+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:
+
+```
+*(Mandarin)*
+*(Chinese)*
+```
+
 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.