From 310736b5761e7ac5d3cec9819a2b66077af74219 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Wed, 26 Apr 2017 13:51:09 +0100
Subject: [PATCH] Standardize README

I had trouble finding the hosted docs for os-vif, which means others are
likely to too. Use the oslo-style README and refer people to other
resources.

Change-Id: I5d7791c86051c5fef20e3deb8bddc29991dd61e3
---
 README.rst           | 76 +++++++-------------------------------------
 doc/source/index.rst |  1 +
 doc/source/usage.rst | 63 ++++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+), 64 deletions(-)
 create mode 100644 doc/source/usage.rst

diff --git a/README.rst b/README.rst
index 90fa7c44..85e67442 100644
--- a/README.rst
+++ b/README.rst
@@ -11,69 +11,17 @@ Team and repository tags
 os-vif
 ======
 
+.. image:: https://img.shields.io/pypi/v/os-vif.svg
+    :target: https://pypi.python.org/pypi/os-vif/
+    :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/dm/os-vif.svg
+    :target: https://pypi.python.org/pypi/os-vif/
+    :alt: Downloads
+
 A library for plugging and unplugging virtual interfaces in OpenStack.
 
-Features
---------
-
-* A base VIF plugin class that supplies a plug() and unplug() interface
-* Versioned objects that represent a virtual interface and its components
-
-Usage
------
-
-The interface to the `os_vif` library is very simple. To begin using the
-library, first call the `os_vif.initialize()` function. This will load
-all installed plugins and register the object model::
-
-    import os_vif
-
-    os_vif.initialize()
-
-Once the `os_vif` library is initialized, there are only two other library
-functions: `os_vif.plug()` and `os_vif.unplug()`. Both methods accept a single
-argument of type `os_vif.objects.VIF`::
-
-    import uuid
-
-    from nova import objects as nova_objects
-    from os_vif import exception as vif_exc
-    from os_vif import objects as vif_objects
-    from os_vif import vnic_types
-
-    instance_uuid = 'd7a730ca-3c28-49c3-8f26-4662b909fe8a'
-    instance = nova_objects.Instance.get_by_uuid(instance_uuid)
-    instance_info = vif_objects.InstanceInfo(
-        uuid=instance.uuid,
-        name=instance.name,
-        project_id=instance.project_id)
-
-    subnet = vif_objects.Subnet(cidr='192.168.1.0/24')
-    subnets = vif_objects.SubnetList([subnet])
-    network = vif_objects.Network(label='tenantnet',
-                                  subnets=subnets,
-                                  multi_host=False,
-                                  should_provide_vlan=False,
-                                  should_provide_bridge=False)
-
-    vif_uuid = uuid.uuid4()
-    vif = vif_objects.VIFVHostUser(id=vif_uuid,
-                                   address=None,
-                                   network=network,
-                                   plugin='vhostuser',
-                                   path='/path/to/socket',
-                                   mode=vif_objects.fields.VIFVHostUserMode.SERVER)
-
-    # Now do the actual plug operations to connect the VIF to
-    # the backing network interface.
-    try:
-        os_vif.plug(vif, instance_info)
-    except vif_exc.PlugException as err:
-        # Handle the failure...
-
-    # If you are removing a virtual machine and its interfaces,
-    # you would use the unplug() operation:
-    try:
-        os_vif.unplug(vif, instance_info)
-    except vif_exc.UnplugException as err:
-        # Handle the failure...
+* License: Apache License, Version 2.0
+* Documentation: https://docs.openstack.org/developer/os-vif
+* Source: https://git.openstack.org/cgit/openstack/os-vif
+* Bugs: https://bugs.launchpad.net/os-vif
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 91b4e737..e0f56a0b 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -7,6 +7,7 @@ os-vif
 
    vif_types
    host_info
+   usage
    plugins/ovs
    plugins/linux-bridge
    glossary
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
new file mode 100644
index 00000000..dcf691fb
--- /dev/null
+++ b/doc/source/usage.rst
@@ -0,0 +1,63 @@
+=====
+Usage
+=====
+
+The interface to the `os_vif` library is very simple. To begin using the
+library, first call the `os_vif.initialize()` function. This will load all
+installed plugins and register the object model:
+
+.. code-block:: python
+
+    import os_vif
+
+    os_vif.initialize()
+
+Once the `os_vif` library is initialized, there are only two other library
+functions: `os_vif.plug()` and `os_vif.unplug()`. Both methods accept a single
+argument of type `os_vif.objects.VIF`:
+
+.. code-block:: python
+
+    import uuid
+
+    from nova import objects as nova_objects
+    from os_vif import exception as vif_exc
+    from os_vif import objects as vif_objects
+    from os_vif import vnic_types
+
+    instance_uuid = 'd7a730ca-3c28-49c3-8f26-4662b909fe8a'
+    instance = nova_objects.Instance.get_by_uuid(instance_uuid)
+    instance_info = vif_objects.InstanceInfo(
+        uuid=instance.uuid,
+        name=instance.name,
+        project_id=instance.project_id)
+
+    subnet = vif_objects.Subnet(cidr='192.168.1.0/24')
+    subnets = vif_objects.SubnetList([subnet])
+    network = vif_objects.Network(label='tenantnet',
+                                  subnets=subnets,
+                                  multi_host=False,
+                                  should_provide_vlan=False,
+                                  should_provide_bridge=False)
+
+    vif_uuid = uuid.uuid4()
+    vif = vif_objects.VIFVHostUser(id=vif_uuid,
+                                   address=None,
+                                   network=network,
+                                   plugin='vhostuser',
+                                   path='/path/to/socket',
+                                   mode=vif_objects.fields.VIFVHostUserMode.SERVER)
+
+    # Now do the actual plug operations to connect the VIF to
+    # the backing network interface.
+    try:
+        os_vif.plug(vif, instance_info)
+    except vif_exc.PlugException as err:
+        # Handle the failure...
+
+    # If you are removing a virtual machine and its interfaces,
+    # you would use the unplug() operation:
+    try:
+        os_vif.unplug(vif, instance_info)
+    except vif_exc.UnplugException as err:
+        # Handle the failure...