Importing Bit-MorseSignals-0.05.tar.gz

[perl/modules/Bit-MorseSignals.git] / lib / Bit / MorseSignals.pm

diff --git a/lib/Bit/MorseSignals.pm b/lib/Bit/MorseSignals.pm
index b2afc844829f652505952ba29fade9325332acbb..3add7d6bffdd2892315ae93902fb08714e62b71a 100644 (file)
--- a/lib/Bit/MorseSignals.pm
+++ b/lib/Bit/MorseSignals.pm
@@ -9,11 +9,22 @@ Bit::MorseSignals - The MorseSignals protocol.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.05
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.05';
+
+=head1 SYNOPSIS
+
+    use Bit::MorseSignals::Emitter;
+    use Bit::MorseSignals::Receiver;
+
+    my $deuce = new Bit::MorseSignals::Emitter;
+    my $pants = new Bit::MorseSignals::Receiver done => sub { print $_[1], "\n" };
+
+    $deuce->post('HLAGH') for 1 .. 3;
+    $pants->push while defined ($_ = $deuce->pop);
 
 =head1 DESCRIPTION
 
@@ -25,7 +36,7 @@ An actual implementation is also provided :
 
 =item L<Bit::MorseSignals::Emitter> is a base class for emitters ;
 
-=item L<Bit::MorseSignals::Receiver> is a base class for receivers ;
+=item L<Bit::MorseSignals::Receiver> is a base class for receivers.
 
 =back
 
@@ -39,7 +50,7 @@ The header is composed of three bits (lowest weight coming first) :
 
 =over 4
 
-=item - The 2 first ones denotes the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object. See also the L</CONSTANTS> sections ;
+=item - The 2 first ones denote the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object. See also the L</CONSTANTS> section ;
 
 =item - The third one is reserved. For compatibility reasons, the receiver should for now enforce the message data type to plain when this bit is lit.
 
@@ -114,7 +125,7 @@ L<Bit::MorseSignals::Emitter>, L<Bit::MorseSignals::Receiver>.
 
 =head1 AUTHOR
 
-Vincent Pit, C<< <perl at profvince.com> >>
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 
 You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).