summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index d5ad6b46a9..abccff6b70 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,21 @@ This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interfac
## 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](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html).
+
## License
See [LICENSE](LICENSE) file.