Merge pull request #1386 from dibdot/dnscrypt-proxy
[project/luci.git] / README.md
1 # OpenWrt luci feed
2
3 ## Description
4
5 This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.
6
7 ## Usage
8
9 This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:
10 ```
11 src-git luci https://github.com/openwrt/luci.git
12 ```
13
14 To install all its package definitions, run:
15 ```
16 ./scripts/feeds update luci
17 ./scripts/feeds install -a -p luci
18 ```
19
20 ## API Reference
21
22 You can browse the generated API documentation [directly on Github](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html).
23
24 ## Development
25
26 Documentation for developing and extending LuCI can be found [in the Wiki](https://github.com/openwrt/luci/wiki)
27
28 ## License
29
30 See [LICENSE](LICENSE) file.
31
32 ## Package Guidelines
33
34 See [CONTRIBUTING.md](CONTRIBUTING.md) file.