Permalink
Browse files

doc update

  • Loading branch information...
1 parent c962c7a commit 98048c54a62cd5e890c188dc18a927c876106476 @nothingmuch nothingmuch committed Dec 26, 2008
Showing with 34 additions and 5 deletions.
  1. +34 −5 lib/Task/KiokuDB.pm
View
@@ -25,27 +25,56 @@ Task::KiokuDB - Install L<KiokuDB> and related modules.
=head1 DESCRIPTION
+This bundle installs L<KiokuDB> and depending on the environment several
+additional components.
+
=head1 MODULES
+All of these are considered optional.
+
=over 4
-=item L<KiokuDB::Backend::JSPON>
+=item L<KiokuDB::Backend::Files>
-The JSON file backend.
+The file backend. Defaults to true.
=item L<KiokuDB::Backend::BDB>
-L<BerkeleyDB> backend. Requires an installed BerkeleyDB, preferably 4.7.
+L<BerkeleyDB> backend. Requires an installed BerkeleyDB, preferably linked
+against 4.7.
+
+Defaults false to unless BDB seems to be installed.
+
+=item L<KiokuDB::Backend::DBI>
+
+The L<DBI> backend.
+
+Defaults to true if you have one of the tested DBDs (SQLite, Pg, or mysql)
+
+=item L<KiokuDB::Backend::CouchDB>
-Defaults to false.
+Defaults to true if you have L<AnyEvent::CouchDB>.
=item L<Data::UUID::LibUUID>
Better UUID generation than L<Data::UUID> (not time based). Requires C<libuuid>
which is available by default on Mac OS X, and easy to install on most Linux
distributions.
-Defaults to false.
+Defaults to false, unless C<uuid.h> can be found and you have a compiler.
+
+=item L<JSON::XS>
+
+Provides faster JSON performance.
+
+Defaults to true if you have a compiler.
+
+=item L<YAML::XS>
+
+Allows dumping/loading DBs as YAML, using YAML serialization, and importing to
+a DB using L<MooseX::YAML> with modern/up to spec YAML files.
+
+Defaults to true if you have a compiler.
=back

0 comments on commit 98048c5

Please sign in to comment.