ci: remove superfluous before_script
[web/firmware-selector-openwrt-org.git] / README.md
index 2452880f739383aec37b9b26d81b11f84aa5e5e6..7ea9464b86dd10fce0a2943407e2de3ffae4d8fc 100644 (file)
--- 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.
 
@@ -42,7 +46,7 @@ If the option is not available (OpenWrt 18.06 or 19.07.3), apply commit [openwrt
 If you want to scrape the OpenWrt download website and update the `config.js`:
 
 ```
-./collect.py --download-url "https://firmware.example.com/{version}/targets/{target}" scrape https://downloads.openwrt.org /var/www/firmware_selector
+./misc/collect.py scrape https://downloads.openwrt.org www/
 ```
 
 ## Similar Projects