Provide .psgi for Plack goodness.

[catagits/Gitalist.git] / README

diff --git a/README b/README
index 88201d2..939d69a 100644 (file)
--- a/README
+++ b/README
@@ -2,20 +2,20 @@ NAME
     Gitalist - A modern git web viewer
 
 SYNOPSIS
-        script/gitalist_server.pl --repo_dir /home/me/code/git
+        perl script/gitalist_server.pl --repo_dir /home/me/code/git
 
 INSTALL
     As Gitalist follows the usual Perl module format the usual approach for
     installation should work, e.g.:
 
-      perl Makefile.PL
-      make
-      make test
-      make install
+        perl Makefile.PL
+        make
+        make test
+        make install
 
     or
 
-      cpan -i Gitalist
+        cpan -i Gitalist
 
     You can also check Gitalist out from its git repository and run it, in
     this case you'll additionally need the author modules, but no
@@ -83,7 +83,7 @@ INITIAL CONFIGURATION
     This means that if you check Gitalist out next to your other git
     checkouts, then starting the demo server needs no parameters at all:
 
-        Gitalist [master]$ ./script/gitalist_server.pl
+        Gitalist [master]$ perl script/gitalist_server.pl
         You can connect to your server at http://localhost:3000
 
   FOR CPAN INSTALLS
@@ -137,6 +137,40 @@ RUNNING
 
         http://example.gitalist.com
 
+CONFIGURATION
+    The Gitalist config is loaded with Catalyst::Plugin::ConfigLoader and
+    the available config options are:
+
+  Model::CollectionOfRepos
+    git Path to the "git" binary.
+
+    repo_dir
+        A directory containing the directories to show.
+
+    repos
+        A list of directories containing repositories to show.
+
+    search_recursively
+        A boolean indicating whether to always search recursively for
+        repositories within "repo_dir".
+
+    whitelist
+        Path a file containing a list of repositories that can be shown.
+        Each line in the file will represent the name of a repo to show e.g
+
+          Gitalist
+          some-bare-repo.git
+
+        This is compatible with "gitweb"'s "projects.list".
+
+    export_ok
+        If provided every must contain a file of the same name to be
+        visible. This is similar to "gitweb"'s functionality.
+
+  paging
+    log The number of commits to show in the summary, shortlog and longlog
+        views.
+
   FASTCGI
     Running Gitalist in FastCGI mode requires a webserver with FastCGI
     support (such as apache with <mod_fcgi> or <mod_fcgid>). Below is a