use document.querySelector

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

diff --git a/README.md b/README.md
index 8eae388694799d34d8c4f7810f64ddf3aba498c9..2021cb33a103e94c3c3da23e3a0c61804cbd9497 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,30 +1,33 @@
 # Yet Another Firmware Selector
 
 A simple OpenWrt firmware selector using autocompletion. Uses plain
-HTML/CSS/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
 
-* Download repository and change directory
+* Checkput the repository and change to the project directory
 * Start webserver (e.g. `python3 -m http.server`)
-* Go to `http://localhost:8000` in your web browser
+* 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 merge the JSON files:
 `./collect.py bin/ --url
 'https://downloads.openwrt.org/releases/{version}/targets/{target}' >
-names-test.json`.
+overview.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)).