some documentation master

Signed-off-by: franck cuny <franck@lumberjaph.net>

1 files changed, 26 insertions, 0 deletions

diff --git a/lib/ballet.pm b/lib/ballet.pm
index d42159b..6248db3 100644
--- a/lib/ballet.pm
+++ b/lib/ballet.pm
@@ -99,3 +99,29 @@ sub update_wiki_page {
 }
 
 true;
+
+=head1 NAME
+
+ballet
+
+=head1 DESCRIPTION
+
+L<ballet> is a wiki powered by L<Dancer> and git.
+
+=head1 CONFIGURATION
+
+edit config.yaml and set:
+
+=head2 wiki_path
+
+Path to the git repository that will hold the pages
+
+=head2 twitter    
+
+The authentication is done via twitter. (see the documentation from L<Dancer::Plugin::Auth::Twitter>).
+    
+  plugins:
+    "Auth::Twitter":
+      consumer_key: "aaa"
+      consumer_secret: "bbbb"
+      callback_url:     "http://localhost:5000/auth/twitter/callback"