From aa70054eca3e1e0d9c6e5376b8742e652066ec0f Mon Sep 17 00:00:00 2001
From: Leonardo Amaral <contato@leonardoamaral.com.br>
Date: Mon, 5 Aug 2024 16:43:14 -0300
Subject: [PATCH] Added README.md

Signed-off-by: Leonardo Amaral <contato@leonardoamaral.com.br>
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e69569a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# docker-woof
+
+## How to use:
+
+```bash
+# Or docker run
+podman run -it --rm --name woof -v ./:/data -p 8008:8008 -e PORT=8008 -e COUNT=1 git.leonardoamaral.com.br/leonardo/woof:latest
+```
+
+Files are served/received from `/data` inside container.
+
+## Variables
+
+* PORT: Port woof will run
+* COUNT: Number of times woof will run. If persistent, keep default and use --restart=always
+* ARGS: Extra arguments. Noticeably `-U` to allow upload instead download