summaryrefslogtreecommitdiff
path: root/pkg/bindings
diff options
context:
space:
mode:
authorSteve Kuznetsov <skuznets@redhat.com>2022-04-11 11:24:59 -0700
committerSteve Kuznetsov <skuznets@redhat.com>2022-04-11 11:26:08 -0700
commitee4a583ed05794265a1a594d433c7b85b3073f02 (patch)
treee6612970749a29210e3f9688fc3ca0e6983b3d84 /pkg/bindings
parent311d66f515d8b85008d483f390987132b89ebeaf (diff)
downloadpodman-ee4a583ed05794265a1a594d433c7b85b3073f02.tar.gz
podman-ee4a583ed05794265a1a594d433c7b85b3073f02.tar.bz2
podman-ee4a583ed05794265a1a594d433c7b85b3073f02.zip
pkg/bindings: document requirements for use
Signed-off-by: Steve Kuznetsov <skuznets@redhat.com>
Diffstat (limited to 'pkg/bindings')
-rw-r--r--pkg/bindings/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/pkg/bindings/README.md b/pkg/bindings/README.md
index 2863039e4..ebc8a13d1 100644
--- a/pkg/bindings/README.md
+++ b/pkg/bindings/README.md
@@ -30,6 +30,10 @@ rootful connections is `/run/podman/podman.sock` and for rootless it is `/run/US
information about the Podman system service, see `man podman-system-service`.
### Creating a connection
+Ensure the [required dependencies](https://podman.io/getting-started/installation#build-and-run-dependencies) are installed,
+as they will be required to compile a Go program making use of the bindings.
+
+
The first step for using the bindings is to create a connection to the socket. As mentioned earlier, the destination
of the socket depends on the user who owns it. In this case, a rootful connection is made.