From bd8aa03fe77fbdaddc932ab3a711caad0857caf0 Mon Sep 17 00:00:00 2001
From: Caspar Armster <caspar@buchlichter.de>
Date: Mon, 9 May 2016 15:17:46 +0200
Subject: [PATCH] [FIX] readme.md angepasst und erweitert

---
 readme.md | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/readme.md b/readme.md
index cf94989..40019cf 100644
--- a/readme.md
+++ b/readme.md
@@ -1,7 +1,36 @@
-{Name}
-======
+Freifunk Hennef Firmware Downloader
+===================================
 
-{Description}
+Beschreibung
+------------
 
-SSH Clone Adresse: {CloneURL.SSH}
-HTTP/HTTPS Clone Adresse: {CloneURL.HTTPS}
\ No newline at end of file
+Der Freifunk Hennef Firmware Downloader soll es Laien ermöglichen schneller schneller und sicherer die zu ihrem Router passende Firmware zu finden. Der Freifunker kann nach einander aus autoamtisch generierten Listen seinen Router auswählen: Hersteller -> Modell -> Version und dann festlegen ob es eine Erstinstallation ist oder nicht, sowie am Ende wählen welches Entwicklungsstadium die Firmware haben soll. Dabei wird automatisch gewarnt (Download Button verändert die Farbe) falls nicht "stable" ausgewählt wird.
+
+Technik
+-------
+
+Der Freifunk Hennef Firmware Downloader scannt das in der config.inc.php angegebene Verzeichnis auf Firmwares in den Unterverzeichnissen (beta/broken/experimental/stable) und dort in (stable/sysupgrade). Aus dem Ergebnis baut das PHP Script ein interaktives Javascript für die Auswahl und verwendet dabei Bootstrap für das Layout.
+
+Bisher werden Router der folgenden Hersteller automatisch erkannt:
+
+- Alfa
+- Allnet
+- Buffalo
+- D-Link
+- GL-Inet
+- LeMaker
+- Linksys
+- Netgear
+- Onion
+- Raspberry Pi
+- TP-Link
+- Ubiquiti
+- Western Digital
+- x86
+
+Soll eine Firmware für Router von anderen Herstellern angeboten werden muss erst das Script geändert werden!
+
+Code
+----
+
+Der Code ist grausam und generiert einen Haufen Variablen/Arrays in PHP aus denen dann "on the fly" ein Javascript Code erzeugt wird. Das geht sicher besser (JSON erzeugen in PHP und wieder ins Javascript einladen) und Fehlertoleranter - aber es ist die erste Version, die erstmal "läuft".
\ No newline at end of file