Add help for download and source

SixArm · Mar 28, 2023 · df8cba2 · df8cba2
1 parent 2e95efd
commit df8cba2
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -2,26 +2,31 @@
 
 POSIX shell script kit is a file of POSIX helper functions.
 
-You simply download the kit file, then source it in your script.
-
-The kit works for bash, zsh, dash, and many other modern Unix shells.
+The kit works for bash, zsh, dash, and many more Unix shells.
 
-The kit is free libre open source software, created by SixArm.
+You simply download the kit file, then source it in your script.
 
 Constructive feedback is welcome and appreciated.
 
-## Usage
+## Download
 
-To download this file:
+To download the POSIX shell script kit file:
 
 ```sh
 curl -O "https://raw.githubusercontent.com/SixArm/posix-shell-script-kit/main/posix-shell-script-kit"
 ```
 
-To include this file in your own script, in the same directory:
+## Source
+
+To use the kit in your own script, you source the kit like this:
+
+```sh
+. /your/path/here/posix-shell-script-kit
+```
+
+To use the kit in your own script in the same directory, you source the kit like this:
 
 ```sh
-# Include https://github.com/SixArm/posix-shell-script-kit
 . "$(dirname "$(readlink -f "$0")")/posix-shell-script-kit"
 ```
 

diff --git a/posix-shell-script-kit b/posix-shell-script-kit
@@ -4,26 +4,31 @@
 #
 # POSIX shell script kit is a file of POSIX helper functions.
 #
-# You simply download the kit file, then source it in your script.
-#
-# The kit works for bash, zsh, dash, and many other modern Unix shells.
+# The kit works for bash, zsh, dash, and many more Unix shells.
 #
-# The kit is free libre open source software, created by SixArm.
+# You simply download the kit file, then source it in your script.
 #
 # Constructive feedback is welcome and appreciated.
 #
-# ## Usage
+# ## Download
 #
-# To download this file:
+# To download the POSIX shell script kit file:
 #
 # ```sh
 # curl -O "https://raw.githubusercontent.com/SixArm/posix-shell-script-kit/main/posix-shell-script-kit"
 # ```
 #
-# To include this file in your own script, in the same directory:
+# ## Source
+#
+# To use the kit in your own script, you source the kit like this:
+#
+# ```sh
+# . /your/path/here/posix-shell-script-kit
+# ```
+#
+# To use the kit in your own script, in the same directory, you source the kit like this:
 #
 # ```sh
-# # Include https://github.com/SixArm/posix-shell-script-kit
 # . "$(dirname "$(readlink -f "$0")")/posix-shell-script-kit"
 # ```
 #