From dad5bafb421f8b14e1664312e5337397a2c37e75 Mon Sep 17 00:00:00 2001
From: Jeff Johnston <johnstonjs@gmail.com>
Date: Wed, 29 May 2019 22:55:31 -0400
Subject: [PATCH] Set v1.0

---
 README.md       | 17 +++++++++++++++++
 gitea-update.sh |  3 +++
 2 files changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cecba07
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# gitea_update_script
+
+A script to automatically update [Gitea](https://gitea.io) installed on local
+host to the latest version from Github.
+
+## Installation
+
+Place in an appropriate location on local host and execute on schedule via cron.
+
+## Dependencies
+
+Requires some basic shell commands listed in the script, and assumes that
+`systemd` is used to start/stop Gitea.
+
+Assumes that Gitea is executed from a symlink specified in $DIR.  The actual
+Gitea binaries are placed in $DIR/bin.  This script will automatically update
+the symlink when a new verson is downloaded.
diff --git a/gitea-update.sh b/gitea-update.sh
index c871c7e..9db9e99 100755
--- a/gitea-update.sh
+++ b/gitea-update.sh
@@ -1,4 +1,7 @@
 #!/bin/sh
+# A shell script to automatically update Gitea
+# Depends only on basic shell utilities (curl, cut, grep, sed, wget)
+# Assumes use of systemd for Gitea start/stop
 
 # Set location of gitea binary on local system
 DIR=/usr/local/bin/gitea