From 24bae5eb5a7f8b83c0ac19462a145842646aa672 Mon Sep 17 00:00:00 2001 From: lub Date: Fri, 23 Oct 2020 23:10:07 +0200 Subject: [PATCH] fix wording in readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1d38505..106df88 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # socat-docker -A simple docker image based on alpine, which basically only socat. +A simple Docker image based on `docker.io/alpine`, which otherwise only contains socat. -It can be used for example to proxy tcp connections to a socket and vice versa for bridging between network namespaced and host networking. +It can be used for example to proxy TCP connections to a Unix socket and vice versa, which is useful for bridging between namespaced and host networking. -This was especially developed to access node_exporter running as --net=host from a prometheus within a regular Docker network. +This was developed specificially to access node_exporter running as `--network=host` from a Prometheus running in a regular Docker network. -UID:GID is random, but consistent across different socat-docker containers for effortless sharing of sockets via bind mounts. +UID:GID in the image is random, but consistent across different socat-docker containers to ensure effortless sharing of sockets via bind mounts.