openwrt-luci/README.md
Jo-Philipp Wich 489fc4b263 docs: various updates
- jsapi: include source links
 - README.md: link to github pages
 - docs/README.md: add stub index page

Signed-off-by: Jo-Philipp Wich <jo@mein.io>
2019-11-07 12:39:24 +01:00

44 lines
1.2 KiB
Markdown

# 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. 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://openwrt.github.io/luci/api/index.html)
- [Client side JavaScript APIs](http://openwrt.github.io/luci/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.
## 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)