* Last API changes before 0.4 API softfreeze
[project/luci.git] / README
diff --git a/README b/README
index 05c4eb8..422eddf 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,12 @@
 FFLuCI - Freifunk Lua Configuration Interface
 
-This is a leightweight MVC-Webframework for small embedded device.
+This is a leightweight MVC-Webframework for small embedded devices.
 It uses the the Lua programming language and relies on Haserl.
 
 It consists of several parts:
 
 MVC Dispatcher
        Simple PATH_INFO based dispatching mechanism using Lua modules
-       
-       > See src/ffluci/dispatcher.lua for a detailed description
-       > See src/ffluci/controller for example controllers
 
 
 Template engine
@@ -22,35 +19,32 @@ Template engine
                <%~uci.short.cut%>
 
        Predefined variables for controller dir and media dir
+       
 
-       > See src/ffluci/template.lua for details
-       > See src/view/ for examples
+Configuration Bind Interface (CBI)
+       Generates and validates XHTML-Forms out of an UCI model description
+       Makes it very easy to create webinterface pages that manipulate UCI files
 
 
 i18n Translation support
        Simple multi-language per-module internationalization support
-       
-       > See src/ffluci/i18n.lua for details
-       > See src/i18n/ for examples
 
 
 UCI wrapper support
        Lua UCI-Wrapper adapting the CLI of the uci binary
 
-       > See src/model/uci.lua for details
-
 
 Menu Building support
        Supports menu building for modules and exported actions
 
-       > See src/ffluci/menu.lua for details
-       > See src/ffluci/view/menu.htm, src/ffluci/controller for examples
-
 
 HTTP-Abstraction and Formvalue validation support
        HTTP-Redirect, Statuscode, Content-Type abstraction
        Dynamic formvalue validation support including varaible type and
        value range validation
 
-       > See src/ffluci/http.lua for details
-       > See src/ffluci/controller/public/example-action.lua for examples
+       
+Known issues:
+       There is a bug in older versions of busybox-httpd (as those in Kamikaze 7.09)
+       that do not handle Status-headers correctly making valid HTTP-Redirects impossible.
+       Using a newer version of Kamikaze should fix this.
\ No newline at end of file