From b3af44668aea144346f99f3b3b0af65275d76277 Mon Sep 17 00:00:00 2001
From: spekulaas <ryan@aterve.nl>
Date: Sat, 25 Sep 2021 20:46:54 +0200
Subject: [PATCH] corrected readme filename and chandged readme

---
 README.md            | 82 ++++++++++++++++++++++++++++++++++++++++++++
 REDME.md             | 33 ------------------
 src/services/help.sh | 10 +++---
 3 files changed, 87 insertions(+), 38 deletions(-)
 create mode 100644 README.md
 delete mode 100644 REDME.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2f46734
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+# Installify
+Installify is a Bash shell script to download new software and applications.
+
+## Applications & Software
+* Android Studio (TO-DO)
+* Bootstrap Studio
+* Chromium (TO-DO)
+* Defold (TO-DO)
+* Discord (TO-DO)
+* Docker (TO-DO)
+* Firefox
+* Gcc
+* Git
+* Node
+* NordVPN
+* OBS
+* PHP
+* Python (TO-DO)
+* Yarn
+* Open-jdk
+* Slack
+* Spotify
+* Visual Studio Code
+* Xampp (TO-DO)
+* ZSH (TO-DO)
+    * Missing any applications or software? Feel free to leave an issue behind or create a merge request with the created files :)
+
+# Use
+
+```console
+wget -P ~/ https://git.aterve.com/Spekulaas/BashInstaller/archive/master.zip
+unzip ~/master.zip
+```
+or with git
+```console
+$ git clone https://git.aterve.com/Spekulaas/BashInstaller.git
+```
+
+`cd $PATH_TO/Installify` and run the script interactively using `sudo ./install.sh [argunments]`:
+
+* -h, -help			Show a list of all commands
+* -v, -version		Show the current version of the application
+* -d				Run the install in debug mode
+* -a				Download all the files without the install command prompt
+* -b				Use bash as main terminal without the prompt
+* -z				Use Oh-My-Zsh as main terminal without the prompt
+
+Example usage:
+
+Manually select the install the files:
+
+```console
+$   sudo ./install.sh
+```
+
+Install files in debug mode:
+
+```console
+$   sudo ./install.sh -d
+```
+
+Install all files in debug mode:
+
+```console
+$   sudo ./install.sh -da
+```
+
+Install all files with Oh-My-Zsh in debug mode:
+
+```console
+$   sudo ./install.sh -daz
+```
+
+Install all files with Oh-My-Zsh:
+
+```console
+$   sudo ./install.sh -az
+```
+
+## TO-DO
+Name change BashInstaller -> Installify
+See applications and software tab
\ No newline at end of file
diff --git a/REDME.md b/REDME.md
deleted file mode 100644
index d9db013..0000000
--- a/REDME.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# BashInstaller
-Simple Bash application installer. 
-
-## Applications & Software
-* Android Studio (TO-DO)
-* Bootstrap Studio
-* Chromium (TO-DO)
-* Defold (TO-DO)
-* Discord (TO-DO)
-* Docker (TO-DO)
-* Firefox
-* Gcc
-* Git
-* Node
-* NordVPN
-* OBS
-* PHP
-* Python (TO-DO)
-* Yarn
-* Open-jdk
-* Slack
-* Spotify
-* Visual Studio Code
-* Xampp (TO-DO)
-* ZSH (TO-DO)
-    * Missing any applications or software? Feel free to leave an issue behind or create a merge request with the created files :)
-
-## TO-DO
-Name change BashInstaller -> Installify
-See applications and software tab
-
-
-	 
\ No newline at end of file
diff --git a/src/services/help.sh b/src/services/help.sh
index b23b635..7a9f16b 100755
--- a/src/services/help.sh
+++ b/src/services/help.sh
@@ -46,15 +46,15 @@ print_help() {
 	# set color
 	printf %s "$YELLOW"
 	cat <<'EOF'
-Usage: Sudo ./install.sh [command oprions]
+Usage: Sudo ./install.sh [arguments]
 
-Command options:
+Arguments:
 	-h, -help			Show a list of all commands
 	-v, -version		Show the current version of the application
 	-d					Run the install in debug mode
-	-a					Download all the files without a command prompt
-	-b					Use bash as main terminal
-	-z					Use Oh-My-Zsh as main terminal
+	-a					Download all the files without the install command prompt
+	-b					Use bash as main terminal without the prompt
+	-z					Use Oh-My-Zsh as main terminal without the prompt
 EOF
 	# set color to default
 	printf %s "$RESET"