From 2f75959d801a8844367e1dc6b264241c45902bf2 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Tue, 25 Jul 2023 03:41:23 +0200 Subject: [PATCH] feat(docs): Explain setup --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ced16d..5a6129e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # copy-docker -A small Docker helper script to get images to remote machines \ No newline at end of file +A small Docker helper script to get images to remote machines + +# Setup + +Get started like so: + +1. Install dependency `pv` +1. Clone repo into arbitrary path `` +1. Make `copy-docker.sh` executable + ``` + chmod +x /copy-docker.sh + ``` +1. Symlink to script, for example + ``` + sudo ln -s /copy-docker.sh /usr/local/bin/copy-docker + ```