From 20c53873d030c2c5c7f1dc5750c122d329377601 Mon Sep 17 00:00:00 2001
From: Trevor Batley <trevor@batley.id.au>
Date: Mon, 24 Jul 2023 09:09:27 +1000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba0526b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# <img src="https://www.koozali.org/images/koozali/Logo/Png/Koozali_logo_2016.png" width="25%" vertical="auto" style="vertical-align:bottom"> rename-e-smith
+
+This script will rename an e-smith package as smeserver and change relevant files (Bugzilla #12359 https://bugs.koozali.org/show_bug.cgi?id=12359)
+
+    rename-emith-pkg.sh <pkg> [<organisation> <local> <force> <debug>]
+
+* \<pkg\> Module name to be renamed (e.g. e-smith-dnscache)
+
+optional parameters, can appear in any order
+
+* \<organisation\> (any gitea organisation smeserver, smecontribs or user - defaults to smeserver)
+* \<local\> will use parameters set for local repository else it will use remote
+* \<force\> will automagically delete an existing repo, otherwise it will prompt
+* \<transfer\> will transfer the updated repository to the source org (need to be owner)
+* \<debug\> run in debug mode
+* \<silent\> will suppress the finished Ok message
+
+Note: this script uses the smeserver-gitutils config file
+
+# e-smith-packages.lst
+Is a text file list of all e-smith packages to be converted, for use with parse-list.sh (from smeserver-gitutils).
\ No newline at end of file