Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bobtfish committed Feb 25, 2012
1 parent d0b19d4 commit 78c6089
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README
Expand Up @@ -70,13 +70,26 @@ METHODS
pack
Inflate an instance from a plain data structure (hashref).

BUILD
An empty build method (which will be silently discarded if you have one
in your class) is provided, and is wrapped to make sure all attributes
are inflated at construction time.

REQUIRED METHODS
stringify
You must implement a stringify method, or compose a stringification role
for all Log::Message::Structured events. This is so that events will
always be meaningfully loggable be printing them to STDOUT or STDERR, or
logging them in a traditional way in a file.

A note about namespace::autoclean
namespace::autoclean does not work correctly with roles that supply
overloading. Therefore you should instead use:

use namespace::clean -except => 'meta';

instead in all classes using Log::Message::Structured.

SEE ALSO
Log::Message::Structured::Stringify::Sprintf
Log::Message::Structured::Stringify::JSON
Expand Down

0 comments on commit 78c6089

Please sign in to comment.