X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Engine-STOMP.git;a=blobdiff_plain;f=README;h=0ab756891022bede434d692bac75bcf5b9c1c1b6;hp=00e5819a9db4ac070bae6bd11d058c5cbc1b4f9a;hb=HEAD;hpb=0a66358961c58c5fff96a363853ee93b00f55119 diff --git a/README b/README index 00e5819..0ab7568 100644 --- a/README +++ b/README @@ -1,16 +1,11 @@ -Catalyst-Engine-Stomp version 0.01 -================================== +Catalyst-Engine-Stomp +===================== -The README is used to introduce the module and provide instructions on -how to install the module, any machine dependencies it may have (for -example C compilers and installed libraries) and any other information -that should be provided before the module is installed. +This is a Catalyst engine which allows you to build a message-driven +application with STOMP. -A README file is required for CPAN modules since CPAN extracts the -README file from a module distribution so that people browsing the -archive can use it get an idea of the modules uses. It is usually a -good idea to provide version information here so that people can -decide whether fixes for the module are worth downloading. +Controllers indicate queues, and message types indicate actions. A +controller base class is provided to handle YAML-serialized messages. INSTALLATION @@ -25,13 +20,21 @@ DEPENDENCIES This module requires these other modules and libraries: - blah blah blah + Moose + Net::Stomp + YAML::XS + Data::Serializer + Catalyst::Engine::Embeddable + Catalyst::Runtime 5.80003 + namespace::autoclean + +The supplied workers script requires MooseX::Workers, and you'll need +the relevant modules to support Data::Serializer if you choose +something other than YAML as a message format. COPYRIGHT AND LICENCE -Put the correct copyright and licence information here. - -Copyright (C) 2008 by Chris Andrews +Copyright (C) 2009 Venda Ltd This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or,