Adding README.md and netcfg examples
Change-Id: I4be73ef61f9585371a777a205105fc370de43dc2
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51db97d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# IGMP Proxy app
+
+IGMP Proxy app receives and decodes igmp report messega from hosts.
+
+## Design Document
+
+Please checkout the detailed design [document](DesignDoc.md).
+
+## Json Examples
+
+After you activated the app in ONOS with
+```bash
+app activate org.opencord.igmpproxy
+```
+You need to submit json files for configuration.
+Some example can be found in the [examples folder](examples).
+Please modify them accordingluy
+
+The command to load a netcfg file is
+```bash
+onos netcfg <onos_ip> path/to/file.json
+```
\ No newline at end of file
diff --git a/examples/device.json b/examples/device.json
new file mode 100644
index 0000000..a823dd7
--- /dev/null
+++ b/examples/device.json
@@ -0,0 +1,13 @@
+{
+ "devices": {
+ "of:00000a0a0a0a0a00": {
+ "basic": {
+ "driver": "voltha"
+ },
+ "accessDevice": {
+ "uplink": 1048576,
+ "vlan": 0
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/examples/igmpproxy.json b/examples/igmpproxy.json
new file mode 100644
index 0000000..036bd26
--- /dev/null
+++ b/examples/igmpproxy.json
@@ -0,0 +1,14 @@
+{
+ "org.opencord.igmpproxy": {
+ "igmpproxy": {
+ "FastLeave": "true",
+ "LastQueryInterval": 1,
+ "MaxResp": 1,
+ "globalConnectPointMode": "true",
+ "globalConnectPoint": "of:00000a0a0a0a0a00/1048576",
+ "enableIgmpProvisioning": "true",
+ "sourceDeviceAndPort": "of:00000a0a0a0a0a00/1048576",
+ "igmpOnPodBasis": "false"
+ }
+ }
+}
\ No newline at end of file