X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=README;h=080c4a106ba2e1661c60c5afe35d7b5f57a6e3b4;hb=59ac23acb023d8b58679dd2e661377bca609e550;hp=63b4b80d9d1590eb4750befc80a519c79afffd2a;hpb=f90efd6aef2e807ed35c07341456ce727d6668bc;p=perl%2Fmodules%2FBit-MorseSignals.git

diff --git a/README b/README
index 63b4b80..080c4a1 100644
--- a/README
+++ b/README
@@ -2,7 +2,17 @@ NAME
     Bit::MorseSignals - The MorseSignals protocol.
 
 VERSION
-    Version 0.01
+    Version 0.06
+
+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);
 
 DESCRIPTION
     In unidirectionnal communication channels (such as networking or IPC),
@@ -15,7 +25,7 @@ DESCRIPTION
     An actual implementation is also provided :
 
     Bit::MorseSignals::Emitter is a base class for emitters ;
-    Bit::MorseSignals::Receiver is a base class for receivers ;
+    Bit::MorseSignals::Receiver is a base class for receivers.
 
     Go to those pages if you just want the stuff done and don't care about
     how it gets there.
@@ -27,9 +37,9 @@ PROTOCOL
 
     The header is composed of three bits (lowest weight coming first) :
 
-    - The 2 first ones denotes the data type : a value of 0 is used for a
+    - 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 Storable
-    object. See also the "CONSTANTS" sections ;
+    object. See also the "CONSTANTS" section ;
     - 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.
@@ -82,7 +92,7 @@ SEE ALSO
     Bit::MorseSignals::Emitter, Bit::MorseSignals::Receiver.
 
 AUTHOR
-    Vincent Pit, "<perl at profvince.com>"
+    Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
     You can contact me by mail or on #perl @ FreeNode (vincent or
     Prof_Vince).
@@ -99,6 +109,9 @@ SUPPORT
 
         perldoc Bit::MorseSignals
 
+    Tests code coverage report is available at
+    <http://www.profvince.com/perl/cover/Bit-MorseSignals>.
+
 COPYRIGHT & LICENSE
     Copyright 2008 Vincent Pit, all rights reserved.