From e8ddb0ca0431553c2bda0306a41fff5f173af302 Mon Sep 17 00:00:00 2001 From: I-Al-Istannen Date: Fri, 15 May 2020 11:02:45 +0200 Subject: [PATCH] Fix example config link in README --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6eacac2..e9b46d3 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ $ cd Vorlesungen $ python3 -m venv . $ . bin/activate $ pip install git+https://github.com/Garmelon/PFERD@rewrite -$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py +$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/rewrite/example_config.py $ python3 example_config.py $ deactivate ``` @@ -38,14 +38,13 @@ $ python3 example_config.py $ deactivate ``` - ## Usage A PFERD config is a normal python file that starts multiple *synchronizers* which do all the heavy lifting. While you can create and wire them up manually, you are encouraged to use the helper methods provided in `PFERD.Pferd`. -The synchronizers take some input arguments specific to their sercice and a +The synchronizers take some input arguments specific to their service and a *transformer*. The transformer receives the computed path of an element in ILIAS and can return either an output path (so you can rename files or move them around as you wish) or `None` if you do not want to save the given file.