From 558f088501ebaaa8639c6eb5ab7bc42a57d0346e Mon Sep 17 00:00:00 2001 From: Terry Wilson Date: Fri, 21 Apr 2017 16:20:55 -0500 Subject: [PATCH] Add a description to README.rst Change-Id: I9723d076a776e3a9f70d47f8faea1aa6f9d51642 --- README.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 150d07f5..4144e9e5 100644 --- a/README.rst +++ b/README.rst @@ -4,9 +4,9 @@ ovsdbapp A library for creating OVSDB applications -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +The ovdsbapp library is useful for creating applications that communicate +via Open_vSwitch's OVSDB protocol (https://tools.ietf.org/html/rfc7047). It +wraps the Python 'ovs' and adds an event loop and friendly transactions. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/ovsdbapp @@ -16,4 +16,6 @@ Note that this is a hard requirement. Features -------- -* TODO +* An thread-based event loop for using ovs.db.Idl +* Transaction support +* Native OVSDB communication