started a user manual

diff --git a/Changes b/Changes
index ef46e9d..b5f7d86 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,4 +1,7 @@
 Revision history for Perl extension Catalyst::Plugin::ConfigLoader.\r
+
+0.14  Thu Sep 28 2006
+    - added a user manual
 \r
 0.13  Fri Aug 25 2006\r
     - loading code factored out into Config::Any [rataxis@cpan.org]\r

diff --git a/MANIFEST b/MANIFEST
index b5c6971..c5b698e 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -1,6 +1,7 @@
 Build.PL\r
 Changes\r
 lib/Catalyst/Plugin/ConfigLoader.pm\r
+lib/Catalyst/Plugin/ConfigLoader/Manual.pod\r
 MANIFEST\r
 t/01-use.t\r
 t/10-live_auto.t\r

diff --git a/lib/Catalyst/Plugin/ConfigLoader.pm b/lib/Catalyst/Plugin/ConfigLoader.pm
index 99500ec..bf688d0 100644 (file)
--- a/lib/Catalyst/Plugin/ConfigLoader.pm
+++ b/lib/Catalyst/Plugin/ConfigLoader.pm
@@ -7,7 +7,7 @@ use Config::Any;
 use NEXT;
 use Data::Visitor::Callback;
 
-our $VERSION = '0.13';
+our $VERSION = '0.14';
 
 =head1 NAME
 
@@ -277,6 +277,8 @@ it under the same terms as Perl itself.
 
 =item * L<Catalyst>
 
+=item * L<Catalyst::Plugin::ConfigLoader::Manual>
+
 =item * L<Config::Any>
 
 =back

diff --git a/lib/Catalyst/Plugin/ConfigLoader/Manual.pod b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod
new file mode 100644 (file)
index 0000000..3558e69
--- /dev/null
+++ b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod
@@ -0,0 +1,78 @@
+=head1 NAME 
+
+Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
+
+=head1 BASIC USAGE
+
+    package MyApp;
+    
+    use Catalyst qw( ConfigLoader ... );
+
+=head1 CONFIG FORMATS
+
+=head2 Config::General
+
+    name = TestApp
+    <Component Controller::Foo>
+        foo bar
+    </Component>
+    <Model Baz>
+        qux xyzzy
+    </Model>
+
+=head2 INI
+
+    name=TestApp
+    
+    [Controller::Foo]
+    foo=bar
+    
+    [Model::Baz]
+    qux=xyzzy
+
+=head2 JSON
+
+    {
+        "name": "TestApp",
+        "Controller::Foo": {
+            "foo": "bar"
+        },
+        "Model::Baz": {
+            "qux": "xyzzy"
+        }
+    }
+
+=head2 Perl
+
+    {
+        name => 'TestApp',
+        'Controller::Foo' => {
+            foo => 'bar'
+        },
+        'Model::Baz' => {
+            qux => 'xyzzy'
+        }
+    }
+
+=head2 XML
+
+    <config>
+        <name>TestApp</name>
+        <component name="Controller::Foo">
+            <foo>bar</foo>
+        </component>
+        <model name="Baz">
+            <qux>xyzzy</qux>
+        </model>
+    </config>
+
+=head2 YAML
+
+    ---
+    name: TestApp
+    Controller::Foo:
+        foo: bar
+    Model::Baz:
+        qux: xyzzy
+
+=cut