rename profiles.json to overview.json (#45)

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

diff --git a/README.md b/README.md
index 4284df2ae44413bbd9d22adb0161c28733564669..48224a9f3e76238f5ea35a9830664b4b3ef6df99 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
 # 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/).
 
 ![image](misc/screenshot.png)
 
-Checkout the [Demo](https://mwarning.github.io/yet_another_firmware_selector/)!
 
 ## Run
 
@@ -15,6 +14,10 @@ Checkout the [Demo](https://mwarning.github.io/yet_another_firmware_selector/)!
 
 Configure with [config.js](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
@@ -24,18 +27,10 @@ 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)).
 
-## Contributions
-
-It would be nice to have more features. E.g.:
-
-* more translations
-* help text for images
-* better CSS
-
 ## Similar Projects
 
 - [Gluon Firmware Selector](https://github.com/freifunk-darmstadt/gluon-firmware-selector): Original source of this project for images generated by [Gluon](https://github.com/freifunk-gluon/), now with pictures.