[CORD-2940] Docs update
Change-Id: Ief3485a2e487b5c7e61c121b5b002963564304fc
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..c23a3da
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,42 @@
+# VRouter service
+
+The vRouter is responsible to configure routes in the Trellis Fabric.
+
+It is required that the `vRouter` service is a `provider_service`
+of the `fabric` service, and the `fabric` service is a `provider_service` of
+ `onos` service (containing the correct applications),
+so that this will be part of your service graph:
+
+```text
+ONOS_Fabric <- Fabric <- vRouter
+```
+
+## Configure a static route
+
+This is an example recipe to configure a static route so that your
+Subscribers can get Internet access:
+
+```yaml
+tosca_definitions_version: tosca_simple_yaml_1_0
+imports:
+ - custom_types/vrouterserviceinstance.yaml
+ - custom_types/vrouterstaticroute.yaml
+description: Creates a vrouter and pushes a static route
+topology_template:
+ node_templates:
+ vrouter#my_vrouter:
+ type: tosca.nodes.VRouterServiceInstance
+ properties:
+ name: my_vrouter
+
+ # Add a static route to the vRouter
+ route#my_route:
+ type: tosca.nodes.VRouterStaticRoute
+ properties:
+ prefix: "0.0.0.0/0" # The destination prefix and netmask (xxx.yyy.www.zzz/nm)
+ next_hop: "192.168.0.254" # The next-hop for the route
+ requirements:
+ - vrouter:
+ node: vrouter#my_vrouter
+ relationship: tosca.relationships.BelongsToOne
+```