Update README.md

README.md

@@ -3,7 +3,8 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/rahveiz/topomate)](https://goreportcard.com/report/github.com/rahveiz/topomate)
 ![CI](https://github.com/rahveiz/topomate/workflows/CI/badge.svg)
 
-Network Topology Automation using FRRouting containers
+Network Topology Automation using FRRouting containers.
+Documentation is available [here](https://topomate.github.io/topomate).
 
 
 ## How does it work ?
@@ -17,81 +18,9 @@ Topomate is still a WIP project with a CLI that is not that user-friendly.
 If you want to try it, I highly suggest you to setup a VM. You'll find more
 informations on [this page](https://github.com/rahveiz/topomate/wiki/Development-VM).
 
-### Example configuration file
+### Example configuration files
 
-```yaml
-autonomous_systems:
-  - asn: 1
-    routers: 2
-    loopback_start: '172.16.10.1/32'
-    igp: OSPF
-    redistribute_igp: true
-    prefix: '10.1.1.0/24'
-    mpls: true
-    links:
-      kind: 'full-mesh'
-      subnet_length: 30
-  - asn: 2
-    routers: 2
-    loopback_start: '172.16.20.1/32'
-    igp: OSPF
-    redistribute_igp: true
-    prefix: '10.1.2.0/24'
-    links:
-      kind: 'full-mesh'
-      subnet_length: 30
-  - asn: 3
-    routers: 2
-    loopback_start: '172.16.30.1/32'
-    igp: OSPF
-    redistribute_igp: true
-    prefix: '10.1.3.0/24'
-    links:
-      kind: 'full-mesh'
-      subnet_length: 30
-  - asn: 4
-    routers: 2
-    loopback_start: '172.16.40.1/32'
-    igp: OSPF
-    redistribute_igp: true
-    prefix: '10.1.4.0/24'
-    links:
-      kind: 'full-mesh'
-      subnet_length: 30
-
-external_links:
-  - from:
-      asn: 1
-      router_id: 1
-    to:
-      asn: 2
-      router_id: 1
-    rel: 'p2c'
-  - from:
-      asn: 2
-      router_id: 1
-    to:
-      asn: 3
-      router_id: 1
-    rel: 'p2p'
-  - from:
-      asn: 2
-      router_id: 1
-    to:
-      asn: 4
-      router_id: 1
-    rel: 'p2c'
-```
-
-This file will :
-
-* generate 8 containers (AS1-R1, AS1-R2, ..., AS4-R2) and the corresponding FRRouting
-configuration files (that will be copied to the corresponding container)
-* create 1 OVS bridge per AS for internal links that will interconnect containers
-(using veth pairs, and OpenFlow rules)
-* create 1 OVS bridge per external link
-
-Currently, the router ID used for BGP and OSPF is the first loopback address.
+You can find configuration files in the *examples* folder.
 
 ## Notes concerning MPLS