Docs for Cache::Store plugins

[catagits/Catalyst-Plugin-Cache.git] / lib / Catalyst / Plugin / Cache / Store.pod

diff --git a/lib/Catalyst/Plugin/Cache/Store.pod b/lib/Catalyst/Plugin/Cache/Store.pod
index 65c8528..dc654f6 100644 (file)
--- a/lib/Catalyst/Plugin/Cache/Store.pod
+++ b/lib/Catalyst/Plugin/Cache/Store.pod
@@ -18,4 +18,27 @@ Catalyst::Plugin::Cache::Store - how to write a Cache store plugin.
 
 =head1 DESCRIPTION
 
+In order to write a cache store plugin, all you need is to implement a method
+following the naming convention:
+
+    setup_<<lower case store name>>_cache_backend {
+
+    }
+
+For example C<setup_fastmmap_cache_backend> for
+L<Catalyst::Plugin::Cache::Store::FastMmap>.
+
+and call C<register_cache_backend> from within that.
+
+The method will get the backend name and configuration as it's first and second
+arguments.
+
+All invokation of the setup methods will be automatic, based on the
+configuration. However, the plugin must be loaded by the user.
+
+Note that store plugins are only necessary if some configuration defaults that
+are catalyst specific need to be provided.
+
+For most cases simply using a cache class instead of a plugin is sufficient.
+
 =cut