From: Tomas Doran (t0m) <t0m@state51.co.uk>
Date: Fri, 30 Sep 2011 09:01:05 +0000 (+0000)
Subject: Update README and fix script path in Makefile.PL
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalystX-HelpText.git;a=commitdiff_plain;h=4d766b1411a368aa03bee2154f941f02fce035f1

Update README and fix script path in Makefile.PL
---

diff --git a/Makefile.PL b/Makefile.PL
index fbdded5..6598c42 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -7,7 +7,7 @@ use Module::Install::AuthorTests;
 name 'CatalystX-HelpText';
 all_from 'lib/CatalystX/HelpText.pm';
 
-install_script 'bin/seartch_undocumented_templates.pl';
+install_script 'bin/search_undocumented_templates.pl';
 
 requires 'Moose';
 requires 'namespace::autoclean';
diff --git a/README b/README
index 9af6fc3..55bf29a 100644
--- a/README
+++ b/README
@@ -1,14 +1,52 @@
 NAME
-    CatalystX::HelpText -
+    CatalystX::HelpText - Helper to include text/html snippets in Catalyst
+    View templates
+
+SYNOPSIS
+    Create a model class in your Catalyst project like: package
+    TestApp::Model::Help; use Moose; use namespace::autoclean;
+
+        extends 'CatalystX::HelpText::Model';
+
+        1;
+
+    Configure it setting value for:
+
+    help_files_path
+        Where the help files will be found
+
+    help_files_ext
+        What is the extension for the help files (default: html)
+
+    wrapper_tag
+        What tag will be used to wrap the shippet (default: span)
+
+    wrapper_css_class
+        What css class will be applied to the wrapper tag (default:
+        help_text)
+
+    Create files with the text/html to be included and store them at
+    help_files_path.
+
+    Apply the CatalystX::HelpText::ViewRole in your View.
+
+    Uses the "[% helptext('SomeHelpTopic') %]"in your templates to include
+    the file "SomeHelpTopic.html" in the page.
+
+    Uses the script "search_undocumented_templates.pl" to find the missing
+    help text files.
+
+SEE ALSO
+    CatalystX::HelpText::Model
+    CatalystX::HelpText::ViewRole
 
-DESCRIPTION
-METHODS
-BUGS
 AUTHOR
-    Cinxgler Mariaca Minda,"cinxgler at ci-info.com"
+    Toomas Doran, "t0m at state51.co.uk"
+
+    Cinxgler Mariaca Minda, "cinxgler at ci-info.com"
 
 COPYRIGHT
-    Copyright state51.
+    Copyright Oscar Music and Media 2011.
 
 LICENSE
     This sofware is free software, and is licensed under the same terms as