X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=bin%2Fgit-codeowners;h=7262df4a558f30aa42a41fa7fe11416fc0273dac;hb=20d609473454c52a00daa59ff30214890ead4211;hp=60e79b27bcd2a8d04b67ca38435c6f06fe718e68;hpb=e3541feec258bc63e2cf5ac387e264816a4bf278;p=chaz%2Fgit-codeowners

diff --git a/bin/git-codeowners b/bin/git-codeowners
index 60e79b2..7262df4 100755
--- a/bin/git-codeowners
+++ b/bin/git-codeowners
@@ -19,12 +19,35 @@
 
 =head1 DESCRIPTION
 
-F<git-codeowners> is yet another CLI tool for managing F<CODEOWNERS> files in
-git repos. In particular, it can be used to quickly find out who owns
-a particular file in a monorepo (or monolith).
+F<git-codeowners> is yet another CLI tool for managing F<CODEOWNERS> files in git repos. In
+particular, it can be used to quickly find out who owns a particular file in a monorepo (or
+monolith).
 
-B<THIS IS EXPERIMENTAL!> The interface of this tool and its modules will
-probably change as I field test some things. Feedback welcome.
+B<THIS IS EXPERIMENTAL!> The interface of this tool and its modules will probably change as I field
+test some things. Feedback welcome.
+
+=head1 INSTALL
+
+There are several ways to install F<git-codeowners> to your system.
+
+=head2 from CPAN
+
+You can install F<git-codeowners> using L<cpanm>:
+
+    cpanm App::Codeowners
+
+=head2 from GitHub
+
+You can also choose to download F<git-codeowners> as a self-contained executable:
+
+    curl -OL https://raw.githubusercontent.com/chazmcgarvey/git-codeowners/solo/git-codeowners
+    chmod +x git-codeowners
+
+To hack on the code, clone the repo instead:
+
+    git clone https://github.com/chazmcgarvey/git-codeowners.git
+    cd git-codeowners
+    make bootstrap      # installs dependencies; requires cpanm
 
 =head1 OPTIONS
 
@@ -146,6 +169,11 @@ C<PERL_TEXT_TABLE> environment variable if desired, like this:
 
 The list of available modules is at L<Text::Table::Any/@BACKENDS>.
 
+=head1 CAVEATS
+
+=for :list
+* Some commands require F<git> (at least version 1.8.5).
+
 =cut
 
 # FATPACK - Do not remove this line.