From: Casey Callendrello <casey.callendrello@coreos.com>
Date: Mon, 15 May 2017 17:07:19 +0000 (+0200)
Subject: Add references to all plugins to the README
X-Git-Url: https://git.halfball.org/?a=commitdiff_plain;h=c9e3fc4890767a619624e804029a8f5975ff28a3;p=plugins.git

Add references to all plugins to the README
---

diff --git a/README.md b/README.md
index 69c4645..5aa1dd5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,23 @@
 # plugins
-Some additional CNI network plugins, matinained by the containernetworking team
+Some CNI network plugins, maintained by the containernetworking team. For more information, see the individual READMEs.
 
 ## Plugins supplied:
+### Main: interface-creating
+* `bridge`: Creates a bridge, adds the host and the container to it.
+* `ipvlan`: Adds an [ipvlan](https://www.kernel.org/doc/Documentation/networking/ipvlan.txt) interface in the container
+* `loopback`: Creates a loopback interface
+* `macvlan`: Creates a new MAC address, forwards all traffic to that to the container
+* `ptp`: Creates a veth pair.
+* `vlan`: Allocates a vlan device.
+
+### IPAM: IP address allocation
+* `dhcp`: Runs a daemon on the host to make DHCP requests on behalf of the container
+* `host-local`: maintains a local database of allocated IPs
+
+### Meta: other plugins
+* `flannel`: generates an interface corresponding to a flannel config file
+* `tuning`: Tweaks sysctl parameters of an existing interface
+
 
 ### Sample
-	The sample plugin provides a base for building a sample plugin with tests.
+The sample plugin provides an example for building your own plugin.