Rework README to markdown
[netconf.git] / README.md
1 # OpenDaylight NETCONF/RESTCONF implementation
2
3 This project hosts implementations of protocols defined by the [IETF NETCONF Working Group](https://datatracker.ietf.org/wg/netconf/about/).
4 In particular it implements: 
5 * [Network Configuration Protocol (NETCONF)](https://www.rfc-editor.org/rfc/rfc6241) 
6 * [RESTCONF Protocol](https://www.rfc-editor.org/rfc/rfc8040)
7
8 Your immediate interests may be: 
9 * Documentation is in [docs](https://docs.opendaylight.org/projects/netconf/en/latest/index.html)
10 * Ready-to-applications are in [apps](apps/README.rst)
11
12 Other that that, you may delve into gory details: 
13 * basic project infrastructure, including [the BOM](artifacts/README.rst>), [Karaf features](features/README.rst),
14 [Dynamic Karaf distribution](karaf/README.rst), [Static Karaf distribution](karaf-static/README.rst) and the [Common Maven Parent](parent/README.rst) 
15 * [YANG models](models/README.rst) relating to this project 
16 * [Transport layer](transport/README.rst) implementation 
17 * [Low-level](protocol/README.rst) protocol implementations 
18 * [High-level](plugins/README.rst) protocol integrations 
19 * [NETCONF Key store](keystore/README.rst) implementation 
20 * [NETCONF Trust store](truststore/READ.rst) implementation 
21 * [applications](apps/README.md) for both end users and integrators