feat(docs): Explain setup

2023-07-25 03:41:23 +02:00 · 2023-07-25 03:41:23 +02:00 · 2f75959d80
commit 2f75959d80
parent e90058a04f
1 changed files with 16 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,18 @@
 # copy-docker

-A small Docker helper script to get images to remote machines
+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 `<repo>`
+1. Make `copy-docker.sh` executable
+    ```
+    chmod +x <repo>/copy-docker.sh
+    ```
+1. Symlink to script, for example
+    ```
+    sudo ln -s <repo>/copy-docker.sh /usr/local/bin/copy-docker
+    ```