From 12f86f1338922179ae07ef982581f5b8957ce791 Mon Sep 17 00:00:00 2001
From: leafus <nxtsrr@proton.me>
Date: Sun, 29 Sep 2024 19:31:24 +0200
Subject: [PATCH] Add README.md

---
 .gitignore |  3 +++
 README.md  | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..17507ca
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+.env
+bin/*
+s3-client*
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6bacff1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# S3 Client Web
+
+This is a WebGUI for [s3-client](https://git.fluffy.pw/leafus/s3-client)
+
+## Prerequisites
+
+- Go (1.23.1 or later)
+
+## Installation
+
+1. Clone the repository:
+   ```
+   git clone https://git.fluffy.pw/leafus/s3-client-web
+   ```
+
+2. Go to the project directory:
+   ```
+   cd s3-client-web
+   ```
+
+3. Build the binary:
+   ```
+   go build -o s3-client-web
+   ```
+
+## Configuration
+
+In the .env file this is the only thing you can set
+
+```
+PORT=8080
+```
+
+### For this to even work
+
+You need to download a latest linux binary release of [s3-client](https://git.fluffy.pw/leafus/s3-client) from the "Releases" tab for your architecture
+
+and put the binary in the "bin" folder !IMPORTANT! you need to rename the file to just s3-client and create s3config.toml file, the configuration of that is in the [s3-client](https://git.fluffy.pw/leafus/s3-client) repository
\ No newline at end of file