Catalyst-Authentication-Store-Htpasswd-1.005

[catagits/Catalyst-Authentication-Store-Htpasswd.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..7db2270
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,43 @@
+This is the Perl distribution Catalyst-Authentication-Store-Htpasswd.
+
+Installing Catalyst-Authentication-Store-Htpasswd is straightforward.
+
+## Installation with cpanm
+
+If you have cpanm, you only need one line:
+
+    % cpanm Catalyst::Authentication::Store::Htpasswd
+
+If it does not have permission to install modules to the current perl, cpanm
+will automatically set up and install to a local::lib in your home directory.
+See the local::lib documentation (https://metacpan.org/pod/local::lib) for
+details on enabling it in your environment.
+
+## Installing with the CPAN shell
+
+Alternatively, if your CPAN shell is set up, you should just be able to do:
+
+    % cpan Catalyst::Authentication::Store::Htpasswd
+
+## Manual installation
+
+As a last resort, you can manually install it. Download the tarball, untar it,
+then build it:
+
+    % perl Build.PL
+    % ./Build && ./Build test
+
+Then install it:
+
+    % ./Build install
+
+If your perl is system-managed, you can create a local::lib in your home
+directory to install modules to. For details, see the local::lib documentation:
+https://metacpan.org/pod/local::lib
+
+## Documentation
+
+Catalyst-Authentication-Store-Htpasswd documentation is available as POD.
+You can run perldoc from a shell to read the documentation:
+
+    % perldoc Catalyst::Authentication::Store::Htpasswd