README.md

@@ -6,9 +6,12 @@

It should be a drop-in replacement for macvlan module.

![Build status](https://github.com/jacekkow/docker-plugin-pyveth/workflows/Release/badge.svg)

## 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.