--- trunk/lib/Frey.pm 2008/07/11 19:19:42 100 +++ trunk/lib/Frey.pm 2008/12/06 00:21:36 730 @@ -1,9 +1,17 @@ package Frey; use Moose; +our $VERSION = "0.24"; + +use Data::Dump qw//; +sub dump { + my ($self,$data) = @_; + Data::Dump::dump( $data ); +} + has 'debug' => ( is => 'rw', - isa => 'Bool', + isa => 'Int', default => 0, ); @@ -13,10 +21,59 @@ =head1 DESCRIPTION -n. Mythology. + n. Mythology. + + The Norse god who dispenses peace, good weather, prosperity, and bountiful + crops; the brother of Freya. + +Basically you write L classes which become deirectly callable from +the Firefox using REST API. for gentle intoduction see L. + +This is just brief overview of concepts so you might check if they suite you +before you get into details. + +=head1 Developer parts + +=head2 Moose classes + +All Moose classes have simple introspection API which use +L to show class and it's pod (using L). + +Example of valid REST URL is + + http://localhost:16001/Frey + +which will show L class introspection. + +You can also add method invocation and optonal parametars to C +constructor like this: + + http://localhost:16001/Frey::Pod/as_markup?class=Frey + +this is same using L from perl as + + Frey::Pod->new( class => 'Frey' )->as_markup; + +Forms to enter required parameters will be generated automatically, +allowing you to explore your data while you are making interface for it. + +=head2 Database + +FIXME broken if not noted in C + +For database objects we support L and when your objects are created +C<< with 'Frey::Collection' >> they will have basic CRUD functionality +implemented by L. + +=head1 User parts + +=head2 Pipes + +See L for now. + +=head1 SEE ALSO -The Norse god who dispenses peace, good weather, prosperity, and bountiful -crops; the brother of Freya. +L =cut