From 238d7a12de4ad095c297f214a76438110798208b Mon Sep 17 00:00:00 2001
From: Julian Hurst <ark@mansus.space>
Date: Thu, 8 Dec 2022 18:34:25 +0100
Subject: Initial commit

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89253a8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# autoindex
+
+## Usage
+	Usage of ./autoindex:
+	  -E	Encrypt the data with a specified password
+	  -b string
+		The autoindex executables directory.
+	  -e	Encrypt the data with a cryptographically secure generated hash
+	  -p int
+		The port to bind to. (default 8080)
+
+## Build & install
+
+To build autoindex, install go and run:
+
+	$ go build
+
+To install, you can run:
+
+	# GOBIN=/usr/local/bin go install
+
+or
+
+	$ GOBIN=$HOME/.local/bin go install
+
+The index.html file must be placed in $HOME/.local/share/autoindex.
-- 
cgit v1.2.3