fix help text for scrape

[web/firmware-selector-openwrt-org.git] / README.md

diff --git a/README.md b/README.md
index 699e1ce49b21813b014d8b29d5fc33eac4a697d3..6ebbb52236b7b7abce79fc1bbbd4f55da6c54644 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,40 @@
 # Yet Another Firmware Selector
 
 A simple OpenWrt firmware selector using autocompletion. Uses plain
-HTML/JavaScript.
+HTML/CSS/JavaScript. Checkout the [Demo](https://mwarning.github.io/yet-another-firmware-selector/www/).
 
 ![image](misc/screenshot.png)
 
-Checkout the [Demo](https://mwarning.github.io/yet_another_firmware_selector/)!
 
-Run:
+## Run
 
-* Download repository and change directory to it
+* Download the sources and change the working directory
 * Start webserver (e.g. `python3 -m http.server`)
-* Go to `http://localhost:8000`
+* Go to `http://localhost:8000/www/` in your web browser
 
-Configure with [config.js](config.js).
+Configure with [config.js](www/config.js).
+
+## Attended Sysupgrade Support
+
+This firmware selector can speak to a [ASU server](https://github.com/aparcar/asu) to build custom images. To enable the feature, the `asu_url` option in the config.js needs to be set.
 
 ## Update Database
 
-The `names-<version>.json` files are based on JSON files created by OpenWrt
+The `overview.json` files are based on JSON files created by OpenWrt
 (master): `Global build settings  ---> [*] Create JSON info files per build
 image`.
 
-A [Python script](misc/collect.py) is included to create those json files:
-`./collect.py bin/ --url
-'https://downloads.openwrt.org/releases/{release}/targets/{target}' >
-names-test.json`.
-
-For the OpenWrt 18.06 and 19.07 releases, you need to patch OpenWrt to output JSON files for collect.py (commit [openwrt/openwrt@881ed09](https://github.com/openwrt/openwrt/commit/881ed09ee6e23f6c224184bb7493253c4624fb9f)).
-
-## Contributions
+A [Python script](misc/collect.py) is included to merge the JSON files into a single overview.json:
+```
+./collect.py merge bin/ --download-url 'https://downloads.openwrt.org/releases/{version}/targets/{target}' > overview.json
+```
 
-It would be nice to have more features. E.g.:
+If you want to scrape the OpenWrt download website and update the config.js:
+```
+./collect.py scrape https://downloads.openwrt.org /var/www/firmware_selector
+```
 
-* more translations
-* help text for images
-* better CSS
+For the OpenWrt 18.06 and 19.07 releases, you need to patch OpenWrt to output JSON files for collect.py (commit [openwrt/openwrt@881ed09](https://github.com/openwrt/openwrt/commit/881ed09ee6e23f6c224184bb7493253c4624fb9f)).
 
 ## Similar Projects