README.md: add link to JS docs
[project/luci.git] / README.md
index d5ad6b46a975e1507705f0f8338b587051c64ded..5518d8fe7b8e4133889cc4e3c4f1a2f5c86ffe0a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,35 @@
 # OpenWrt luci feed
 
+[![Translation status](https://hosted.weblate.org/widgets/openwrt/-/svg-badge.svg)](https://hosted.weblate.org/engage/openwrt/?utm_source=widget)
+
 ## Description
 
 This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.
 
 ## Usage
 
-This feed is enabled by default. To install all its package definitions, run:
+This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:
+```
+src-git luci https://github.com/openwrt/luci.git
+```
+
+To install all its package definitions, run:
 ```
 ./scripts/feeds update luci
 ./scripts/feeds install -a -p luci
 ```
 
+## API Reference
+
+You can browse the generated API documentation directly on Github.
+
+ - [Server side Lua APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html)
+ - [Client side JavaScript APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/jsapi/index.html)
+
+## Development
+
+Documentation for developing and extending LuCI can be found [in the Wiki](https://github.com/openwrt/luci/wiki)
+
 ## License
 
 See [LICENSE](LICENSE) file.
@@ -19,3 +37,7 @@ See [LICENSE](LICENSE) file.
 ## Package Guidelines
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Translation status
+
+[![Translation status](https://hosted.weblate.org/widgets/openwrt/-/multi-auto.svg)](https://hosted.weblate.org/engage/openwrt/?utm_source=widget)