summaryrefslogtreecommitdiffhomepage
path: root/docs/README.md
diff options
context:
space:
mode:
authorPaul Donald <newtwen@gmail.com>2024-02-15 18:09:10 +0100
committerPaul Donald <newtwen@gmail.com>2024-02-15 18:09:10 +0100
commit1635bbfad4acefa18d20fe372e45c6ef747b33e1 (patch)
treebd39ebcd8b46dbd10e9c7c09150c9ca2e4169d99 /docs/README.md
parent6644f90e9c2f7efe72fcd1a31a6355013ac248fc (diff)
docs: structuring and overhaul
Signed-off-by: Paul Donald <newtwen@gmail.com>
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md
index c64cf9405e..eeb5d0ead4 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,5 +4,21 @@ See Wiki [LuCI Technical Reference](https://openwrt.org/docs/techref/luci)
## API Reference
- - [Client side JavaScript APIs](jsapi/)
- - [Server side Lua APIs](api/index.html)
+- [Client side JavaScript APIs](jsapi/)
+- [How to i18n your module](i18n): internationalization via \*.po and \*.pot files
+- [How to make LuCI JS Modules](https://github.com/openwrt/luci/tree/master/applications/luci-app-example): see the luci-app-example in the repo
+- [How to use the JSON-RPC](JsonRpcHowTo)
+- [How to make themes](ThemesHowTo)
+- [LuCI Modules Reference](Modules): can be JS based or Lua (deprecated)
+
+## Deprecated API Reference (older Lua based APIs)
+
+- [CBI models reference](CBI):CBI models are Lua files describing the structure of an UCI config file and the resulting HTML form to be evaluated by the CBI parser
+- [How to make LuCI Lua Modules](ModulesHowTo): No new Lua modules for client side display are accepted, but some server side things are still done in Lua
+- [LMO - Lua Machine Objects](LMO): to pack language strings into a more efficient form for Lua
+- [Server side Lua APIs](api/index.html)
+- [Templates](Templates): template processor which parses HTML-files to Lua functions and allows to store precompiled template files
+
+## Archived
+
+- [LuCI-0.10](LuCI-0.10): No longer used, but useful reference if you encounter older LuCI versions. \ No newline at end of file