Preparing for 3.3.0

example/README.md

@@ -1,8 +1,8 @@
-Clixon yang routing example
-+++++++++++++++++++++++++++
+# Clixon yang routing example
 
-0. Compile and run
-------------------
+
+## Compile and run
+```
 cd example
 make && sudo make install
 # Start backend
@@ -11,9 +11,10 @@ clixon_backend -f /usr/local/etc/routing.conf -I
 clixon_cli -f /usr/local/etc/routing.conf
 # Send netconf command
 clixon_netconf -f /usr/local/etc/routing.conf
+```
 
-1. Setting data example using netconf
--------------------------------------
+## Setting data example using netconf
+```
 <rpc><edit-config><target><candidate/></target><config>
       <interfaces>
          <interface>
@@ -28,10 +29,10 @@ clixon_netconf -f /usr/local/etc/routing.conf
          </interface>
       </interfaces>
 </config></edit-config></rpc>]]>]]>
+```
 
-2. Getting data using netconf
------------------------------
-
+## Getting data using netconf
+```
 <rpc><get-config><source><candidate/></source></get-config></rpc>]]>]]>
 
 <rpc><get-config><source><candidate/></source><filter/></get-config></rpc>]]>]]>
@@ -43,25 +44,29 @@ clixon_netconf -f /usr/local/etc/routing.conf
 <rpc><get-config><source><candidate/></source><filter type="xpath" select="/interfaces/interface/ipv4"/></get-config></rpc>]]>]]>
 
 <rpc><validate><source><candidate/></source></validate></rpc>]]>]]>
+```
+
+## Creating notification
 
-3. Creating notification
-------------------------
 The example has an example notification triggering every 10s. To start a notification 
 stream in the session, create a subscription:
+```
 <rpc><create-subscription><stream>ROUTING</stream></create-subscription></rpc>]]>]]>
 <rpc-reply><ok/></rpc-reply>]]>]]>
 <notification><event>Routing notification</event></notification>]]>]]>
 <notification><event>Routing notification</event></notification>]]>]]>
 ...
-
+```
 This can also be triggered via the CLI:
+```
 cli> notify 
 cli> Routing notification
 Routing notification
 ...
+```
+
+## Extending
 
-4. Downcall
------------
 Clixon has an extension mechanism which can be used to make extended internal
 netconf messages to the backend configuration engine. You may need this to
 make some special operation that is not covered by standard
@@ -71,11 +76,13 @@ reference. A more realistic downcall would perform some action, such as
 reading some status.
 
 Example:
+```
 cli> downcall "This is a  string"
 This is a string
-cli>p
+```
 
-5. Run as docker container
---------------------------
+## Run as docker container
+```
 cd docker
 # look in README
+```