Improve docs and fix bug in workflow that missed the man page

Author: stilvoid

.github/workflows/release.yml

@@ -19,4 +19,4 @@ jobs:
             LICENSE
             README.md
             git-get
-            .get-get.1
+            git-get.1

README.md

@@ -4,21 +4,58 @@ git-get is an opinionated git command that helps you keep your code folder in or
 
 git-get is a simple wrapper for `git clone` that clones your repository into a standard location so that you always know where your code is.
 
-git-get will place you inside your new folder when you're done because it saves typing `cd <the thing you just typed already>` :)
-
 ## Installing
 
-All you get to do is to put `git-get` somewhere in your path :)
+Just put `git-get` somewhere in your path :)
+
+## Usage
+
+```
+git get [--print-path] <repository> [<args>]
+```
+
+### Arguments
+
+- `<repository>` - The repository URL to clone (required)
+- `[<args>]` - Additional arguments passed directly to `git clone`
+
+### Options
+
+- `--print-path` - Print the full path where the repository would be cloned and exit without cloning
+- `-h, --help` - Show help message and exit
 
 ## Examples
 
+### Basic Usage
+
 ```shell
 git get https://github.com/stilvoid/git-get
-Cloning into '/home/steve/code/github.com/stilvoid/git-get'...
+Cloning into '/home/bob/code/github.com/stilvoid/git-get'...
+Successfully cloned to: /home/bob/code/github.com/stilvoid/git-get
 ```
 
 git-get uses the repository URL to figure out where to place your checked out copy.
 
+### Supported URL Formats
+
+git-get works with various repository URL formats:
+
+```shell
+# HTTPS URLs
+git get https://github.com/stilvoid/git-get.git
+# → ~/code/github.com/stilvoid/git-get
+
+# SSH URLs
+git get [email protected]:stilvoid/git-get.git
+# → ~/code/github.com/stilvoid/git-get
+
+# Git protocol URLs
+git get git://github.com/stilvoid/git-get.git
+# → ~/code/github.com/stilvoid/git-get
+```
+
+### Configuration
+
 By default, git-get places all repositories under `~/code` but you can change that by setting get.location:
 
 ```shell

git-get

@@ -8,14 +8,16 @@ function print_help {
     echo "  git-get clones <repository> into a folder derived from the repository URL"
     echo
     echo "  For example, git get [email protected]:stilvoid/git-get.git"
-    echo "  will be checkout into ~/code/github.com/stilvoid/git-get.git"
+    echo "  will be cloned into ~/code/github.com/stilvoid/git-get"
     echo
     echo "  You can override the default base path (~/code) with"
-    echo "  git config --global get.loation \"/path/to/your/code\""
+    echo "  git config --global get.location \"/path/to/your/code\""
     echo
-    echo "  --print-path will print out the full path that the repository would be clone into"
+    echo "  --print-path will print out the full path that the repository would be cloned into"
     echo "  and then exits immediately without cloning"
     echo
+    echo "  -h, --help show this help message and exit"
+    echo
     echo "  Any other arguments are passed to the \"git clone\" command"
 }
 
@@ -85,6 +87,9 @@ if [ "$COMMAND" == "print" ]; then
     exit
 fi
 
+echo "Cloning into '$dir'..."
 CMD="git clone $GIT_ARGS -- \"$REPO\" \"$dir\""
 
 eval "$CMD"
+
+echo "Successfully cloned to: $dir"

git-get.1

@@ -1,17 +1,34 @@
 .TH "GIT\-GET" "1" "2025-01-10" "https://github.com/stilvoid/git-get" "Git Manual"
 .SH NAME
-git-git \- clone a git repository into a folder structure derived from the repository URL
+git-get \- clone a git repository into a folder structure derived from the repository URL
 .SH SYNOPSIS
 .B git-get
+[\fB\-h\fR | \fB\-\-help\fR | \fB\-\-print\-path\fR]
 .IR repository
+[\fIargs\fR...]
 .SH DESCRIPTION
 .Nm
 clones
 .IR repository
 into a folder derived from the repository URL by removing the scheme (e.g. \fIhttps://\fR),
 the username (e.g. \fIgit@\fR),
 and the suffix \fI.git\fR if it exists.
-.SH EXAMPLE
+.SH OPTIONS
+.TP
+.B \-\-print\-path
+Print the full path where the repository would be cloned and exit without cloning.
+.TP
+.B \-h, \-\-help
+Show help message and exit.
+.PP
+Any additional arguments are passed directly to the \fBgit clone\fR command.
+.SH CONFIGURATION
+You can override the default base path (\fI~/code\fR) with:
+.PP
+.RS
+$ git config --global get.location "/path/to/your/code"
+.RE
+.SH EXAMPLES
 .PP
 Clone the git-get repository:
 .PP
@@ -31,10 +48,8 @@ will both result in the repository being checked out to
 $HOME/code/github.com/stilvoid/git-get
 .RE
 .PP
-You can override the default base path (
-.I ~/code
-) with:
+Preview where a repository would be cloned:
 .PP
 .RS
-$ git config --global get.loation "/path/to/your/code"
+$ git get --print-path https://github.com/stilvoid/git-get.git
 .RE