From 9a380de0876d9a513e13d2cad7685a728e241c90 Mon Sep 17 00:00:00 2001
From: Gogs <gogs@fake.local>
Date: Tue, 28 Sep 2021 19:46:29 +0200
Subject: [PATCH] Add README.md and comments

---
 README.md        | 20 ++++++++++++++++++++
 upgrade-gitea.sh |  4 ++--
 2 files changed, 22 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c1f0d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Automatic upgrade for Gitea
+
+## WARNING
+No guarantees, only tested in my environment, don't come and complain.
+
+## Prerequisite
+
+Please fill in the `work` and `gitea` variables at the beginning of the script (usually, only `work` have to be customize).
+
+## Use
+
+```
+./upgrade-gitea.sh
+```
+
+You can specify a version, else it take the last stable.
+
+If something go wrong, you will find a backup of your last executable in /tmp/gitea
+
+
diff --git a/upgrade-gitea.sh b/upgrade-gitea.sh
index 3526e7d..d5e5763 100755
--- a/upgrade-gitea.sh
+++ b/upgrade-gitea.sh
@@ -1,8 +1,8 @@
 #!/bin/bash
 
 # Custom location
-work="$HOME/apps"
-gitea="$work/gitea"
+work="$HOME/apps"	# Location of your Gitea installation
+gitea="$work/gitea"	# Location of your Gitea executable
 
 # If run as root, yell at me and exit
 [[ $EUID -eq 0 ]] && echo "Don't use root to manage Gitea... It sucks..." && exit 1