From: Moritz Warning <moritzwarning@web.de>
Date: Wed, 23 Sep 2020 18:36:52 +0000 (+0200)
Subject: README.md: add documentation for {base} variable
X-Git-Tag: v3.0.3~3
X-Git-Url: http://git.openwrt.org/?a=commitdiff_plain;h=6a42ab5e1600660fa762b1f699a8bb89011261c2;p=web%2Ffirmware-selector-openwrt-org.git

README.md: add documentation for {base} variable
---

diff --git a/README.md b/README.md
index 2452880..fa7cc13 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,11 @@ Place the `www/` folder somewhere web accessible. Then use the `collect.py` scri
 
 This should do it.
 
-The https link is used to access image files. `{version}` will be replaced by the name of the release, e.g. `19.07.4`. `{taget}` will be replaced by the main- and sub target, e.g. `ath79/generic`.
+The https link is used to access image files. There are different variables available:
+
+* `{version}`: Version in the profiles.json files. E.g. `19.07.4` or `SNAPSHOT`.
+* `{target}`: Main- and sub target, E.g. `ath79/generic`.
+* `{base}`: Distinct path to the targets directory. E.g. `releases/18.06.8/targets/`
 
 The `collect.py` script searches the `~/openwrt/bin/` directory for `profile.json` files. These are merged into `overview.json` files (one per release). The `overview.json` files are then placed into `www/data/` and `www/config.js` is updated.