diff --git a/README.rst b/README.rst index 39ced528..49949aaf 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,20 @@ -================= -networking-bgpvpn -================= +=============================================== +BGP-MPLS VPN Extension for OpenStack Networking +=============================================== -API and Framework to interconnect BGP/MPLS VPNs to Openstack Neutron networks +This project provides an API and Framework to interconnect BGP/MPLS VPNs +to Openstack Neutron networks, routers and ports. + +The Border Gateway Protocol and Multi-Protocol Label Switching are widely +used Wide Area Networking technologies. The primary purpose of this project +is to allow attachment of Neutron networks and/or routers to carrier +provided WANs using these standard protocols. An additional purpose of this +project is to enable the use of these technologies within the Neutron +networking environment. + +A vendor neutral API and data model is provided such that multiple backends +may be "plugged in" while offering the same tenant facing API. A reference +implementation based on an Open Source BGP implementation is also provided. * Free software: Apache license * Source: http://git.openstack.org/cgit/openstack/networking-bgpvpn diff --git a/doc/source/index.rst b/doc/source/index.rst index b55d4f80..5029cb99 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,15 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to networking-bgpvpn's documentation! -======================================================== +Welcome to BGP-MPLS VPN Networking Documentation! +================================================= +.. include:: ../../README.rst + Contents: .. toctree:: :maxdepth: 2 - readme installation usage contributing diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst