From 0700f847c59d44155ad89917b52dd58dc89f3b73 Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Wed, 11 Mar 2026 19:24:05 +0000
Subject: [PATCH] Allocate point-to-point addresses when option ptp=1 is specified

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

diff --git a/README.md b/README.md
index 717d384..c4360c0 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,22 @@
 
 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"!
+
 ## Manual packaging
 
 In order to test this module in development environment, you can build it

--
Gitblit v1.10.0