From 52429e521bfa86991b172c56caccd93d1fe82ef3 Mon Sep 17 00:00:00 2001
From: Endre Karlson <endre.karlson@gmail.com>
Date: Fri, 5 Oct 2012 14:52:54 +0200
Subject: [PATCH] README..

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..2edf7655
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+Puppet module providing things for vSwitches. At the moment OVS is the only
+one I've added but please feel free to pull request this!
+
+It's based upon types & providers so we can support more then just OVS or one
+vSwitch type.
+
+Current layout is:
+bridges - A "Bridge" is basically the thing you plug ports / interfaces into.
+ports - A Port is a interface you plug into the bridge (switch).
+
+USAGE:
+Place this directory at:
+<your module directory of choice>/vswitch
+
+Then in your manifest you can either use the things as parameterized classes:
+class {"vswitch::bridge":
+    name => "br-ex"
+}
+class {"vswitch::port": 
+    interface => "eth0",
+    bridge    => "br-ex"
+}
+
+Or you can use them as "Providers":
+vs_bridge {"br-ex":}
+vs_port {"eth0": bridge => "br-ex"}
+
+TODO:
+* OpenFlow controller settings
+* OpenFlow Settings
+* OpenFlow Tables
+* More facts
+* Others that are not named here