about summary refs log tree commit diff
diff options
context:
space:
mode:
authorEmile <hanemile@protonmail.com>2020-03-22 16:00:26 +0100
committerEmile <hanemile@protonmail.com>2020-03-22 16:00:26 +0100
commit0ed53a866cd46efce78d00231664fb7e878ae527 (patch)
treecfd68b70da611856b2f385ba64bc69aeb97bd66c
parenta648fa0d315915f17a119a9b3b38316280a71146 (diff)
readme usage
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5caaa91..719def1 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,15 @@
 
 # faila
 
-caddy's file server, but as a standalone application
\ No newline at end of file
+caddy's file server, but as a standalone application
+
+## Usage
+
+Use the docker-container located here: `registry.darknebu.la/emile/faila:latest` for the latest docker release, else, simply pull it using:
+
+```bash
+$ go get git.darknebu.la/emile/faila
+...
+```
+
+Be sure to adjust the parameters in the config!
\ No newline at end of file