Permalink
Browse files

Add some docs and a code example

  • Loading branch information...
1 parent 225e2fe commit 8b24c0a680049db9d1e57eaa597f47a0128b5733 @leto committed Jun 30, 2011
Showing with 11 additions and 3 deletions.
  1. +11 −3 lib/Algorithm/Soundex.pm
View
14 lib/Algorithm/Soundex.pm
@@ -31,17 +31,25 @@ class Algorithm::Soundex {
=head1 NAME
-Algorithm::Soundex - The Soundex Algorithm
+Algorithm::Soundex - Soundex Algorithms
=head1 DESCRIPTION
-The very simple American Soundex algorithm, implemented in Perl 6.
+Currently this module contains the American Soundex algorithm, implemented in Perl 6.
+
+If you would like to add other Soundex algorithms, Patches Welcome! No, they are
+*actually* welcome :)
=head1 SYNOPSIS
=begin code
-INSERT CODE HERE
+ use v6;
+ use Algorithm::Soundex;
+
+ my Algorithm::Soundex $s .= new();
+ my $soundex = $s.soundex("Leto");
+ say "The soundex of Leto is $soundex";
=end code

0 comments on commit 8b24c0a

Please sign in to comment.