]> git.vpit.fr Git - perl/modules/Bit-MorseSignals.git/blobdiff - README
Update VPIT::TestHelpers to 15e8aee3
[perl/modules/Bit-MorseSignals.git] / README
diff --git a/README b/README
index 04205368cef8e4370f24581c201ea87db542ca2a..7b7f849d955562e250192eb5a98167bc9688b898 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,17 @@ NAME
     Bit::MorseSignals - The MorseSignals protocol.
 
 VERSION
-    Version 0.02
+    Version 0.08
+
+SYNOPSIS
+        use Bit::MorseSignals::Emitter;
+        use Bit::MorseSignals::Receiver;
+
+        my $deuce = Bit::MorseSignals::Emitter->new;
+        my $pants = Bit::MorseSignals::Receiver->new(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.
@@ -82,10 +92,9 @@ 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).
+    You can contact me by mail or on "irc.perl.org" (vincent).
 
 BUGS
     Please report any bugs or feature requests to "bug-bit-morsesignals at
@@ -99,6 +108,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.