Changeset 101 in bookmarks for trunk/lib

Timestamp:

07/01/15 16:18:22 (9 years ago)

Author:

peter

Message:

added some perldoc to BookmarksApp

File:

• trunk/lib/BookmarksApp.pm (modified) (2 diffs)

trunk/lib/BookmarksApp.pm

@@ -1 +1 @@
 package BookmarksApp;
+
+=head1 NAME
+
+BookmarksApp
+
+=head1 SYNOPSIS
+
+    use BookmarksApp;
+    use Digest::MD5 qw{md5_hex};
+
+    my $username = '...';
+    my $password = '...';
+    my $app = BookmarksApp->new({
+        config => {
+            dbname => 'bookmarks.db',
+
+            # set these if you want non-GET requests to require authentication
+            auth            => 1,
+            digest_key      => 'secret',
+            digest_password => md5_hex("$username:Bookmarks:$password"),
+            
+            # set this if the app is running behind a proxy server
+            proxy_ip  => '...',
+        },
+    });
+
+    # returns the coderef appropriate for use in an app.psgi,
+    # or for passing the Plack::Runner, etc.
+    $app->to_app;
+
+=cut
 
 use strict;
@@ -103 +134 @@
 # module return
 1;
+
+=head1 AUTHOR
+
+Peter Eichman <peichman@cpan.org>
+
+=cut