diff options
author | franck cuny <franck@lumberjaph.net> | 2010-02-10 14:28:10 +0100 |
---|---|---|
committer | franck cuny <franck@lumberjaph.net> | 2010-02-10 14:28:10 +0100 |
commit | 863fcc4e109fe286de20e4b56141e0e7b2c237b4 (patch) | |
tree | ab7752b9fca16609db28c003cfa9b4d9e1eb6b2b | |
parent | makefile (diff) | |
download | moosex-privacy-863fcc4e109fe286de20e4b56141e0e7b2c237b4.tar.gz |
update readme, need to write POD now
-rw-r--r-- | README | 38 |
1 files changed, 18 insertions, 20 deletions
diff --git a/README b/README index d095bb5..950e8c0 100644 --- a/README +++ b/README @@ -1,27 +1,25 @@ -This is Perl module MooseX::Privacy. +NAME + MooseX::Privacy - Provides syntax to enable privacy on your methods -INSTALLATION +SYNOPSIS + use MooseX::Privacy; -MooseX::Privacy installation is straightforward. If your CPAN shell is set up, -you should just be able to do + private foo => sub { + return 23; + }; - % cpan MooseX::Privacy + protect bar => sub { + return 42; + }; -Download it, unpack it, then build it as per the usual: +DESCRIPTION + MooseX::Privacy is - % perl Makefile.PL - % make && make test +AUTHOR + franck cuny <franck.cuny@rtgi.fr> -Then install it: +SEE ALSO +LICENSE + This library is free software; you can redistribute it and/or modify it + under the same terms as Perl itself. - % make install - -DOCUMENTATION - -MooseX::Privacy documentation is available as in POD. So you can do: - - % perldoc MooseX::Privacy - -to read the documentation online with your favorite pager. - -franck cuny |