From: Moritz Warning <moritzwarning@web.de>
Date: Tue, 28 Jan 2020 01:37:04 +0000 (+0100)
Subject: update readme
X-Git-Tag: v1.0.0~55
X-Git-Url: http://git.lede-project.org./?a=commitdiff_plain;h=cbbe4d97ba2b22f3f9eaf338d9fb39604e7c3c45;p=web%2Ffirmware-selector-openwrt-org.git

update readme
---

diff --git a/README.md b/README.md
index 308a31f..a104b35 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,24 @@
 # Yet Another Firmware Selector
 
-Still in development state. OpenWrt can now create json files that can be globbed together. No need for heuristics on firmware names anymore.
+A simple OpenWrt firmware selector using autocompletion.
 
-```
-git clone ...
-cd yet*
-python3 -m http.server
-```
+![image](screenshot.png)
 
-Create a new `data.json` by using the `./collect.py bin > data.json` script.
+Run:
+
+* Download repository.
+* Go to project directory.
+* Start webserver (e.g. `python3 -m http.server`)
+* Go to `http://localhost:8000`
+
+## Update Database
+
+OpenWrt master has a feature to create json files. The included python script can merge all these files for a new data.json file: `./collect.py bin/ bin2/ > data.json`
+
+## Contributions
+
+It would be nice to have more features. E.g.:
+
+* more translations
+* help text for images
+* better CSS
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..6f2a869
Binary files /dev/null and b/screenshot.png differ