From e2cff67419aa5d55b143ddea7f25b7ff0ca77e28 Mon Sep 17 00:00:00 2001 From: Jacek Kowalski <Jacek@jacekk.info> Date: Fri, 22 May 2020 16:09:24 +0000 Subject: [PATCH] Add build badge and Docker Hub URL to README --- README.md | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 46ee19d..29ebfc9 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,12 @@ It should be a drop-in replacement for macvlan module. + + ## Installation Plugin is packaged as [Docker Engine-managed plugin](https://docs.docker.com/engine/extend/). +Check out [plugin page on Docker Hub](https://hub.docker.com/p/jacekkow/pyveth). To install it simply run: @@ -28,12 +31,14 @@ One will be pushed inside the container and another will remain on host (without any IP assigned). -Plugin accepts optional `parent` parameter, which is be a name of bridge +Plugin accepts optional `parent` parameter, which is a name of bridge interface that the second interface should be added to: ```bash docker network create --driver jacekkow/pyveth:latest --opt parent=br0 new-network ``` + +This way host interface will be automatically attached to the specified bridge. ## Manual packaging @@ -42,5 +47,3 @@ You can also use `package.sh` helper script which will perform all the steps (including installation) automatically. - - -- Gitblit v1.9.1