From 2e8d847c4fbccbd27566ad4f1484b7809ac62cd7 Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Wed, 11 Mar 2026 19:24:05 +0000
Subject: [PATCH] Workflows: deploy to GitHub Container Registry

---
 README.md |   25 +++++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
index 717d384..58324ce 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,31 @@
 
 Check out [`test_integration.sh`](test_integration.sh) for more examples.
 
+## Options
+
+To use options, add `--ipam-opt option=value` as an argument of `docker network create`:
+
+```bash
+docker network create --ipam-driver jacekkow/pyipam:latest --ipam-opt ptp=1 new-network
+```
+
+Available options:
+
+`ptp=1`
+
+When set addresses with netmask /32 (IPv4) or /128 (IPv6) are handed out.
+In this mode all IP addresses are handed out from the subnet,
+including ones that would be "network address" and "broadcast address"!
+
+`validate=0`
+
+Do not validate duplicate IP address assignment. This IPAM plugin would
+then happily hand out already-used addresses if such were manually specified.
+This option does not affect automatic assignments.
+Note that this module does not track how many times the IP was handed out,
+hence if two containers have the same IP and one of them stops,
+IP will be marked as free!
+
 ## Manual packaging
 
 In order to test this module in development environment, you can build it

--
Gitblit v1.10.0