From: Marius Gavrilescu <marius@ieval.ro>
Date: Sat, 29 Aug 2015 21:58:52 +0000 (+0300)
Subject: Update POD and README
X-Git-Tag: 0.001002~1
X-Git-Url: http://git.ieval.ro/?a=commitdiff_plain;h=5f2b55bea0b0f92bc73fcef46336ee2b64097e8d;p=poe-component-irc-plugin-seen.git

Update POD and README
---

diff --git a/README b/README
index 8610521..8e7f279 100644
--- a/README
+++ b/README
@@ -1,9 +1,14 @@
 POE-Component-IRC-Plugin-Seen version 0.001001
 ==============================================
 
-POE::Component::IRC::Plugin::Seen is a PoCo-IRC plugin that remembers what each person around it did last.
+POE::Component::IRC::Plugin::Seen is a PoCo-IRC plugin that remembers
+what each person around it did last. It remembers public messages,
+joins and parts.
 
-When somebody sends him a private message of the form 'seen NICKNAME' or somebody says 'botnick: seen NICKNAME' in a channel with the bot, the plugin answers with the last action NICKNAME did.
+When somebody sends him a private message of the form 'seen NICKNAME'
+or somebody says 'seen NICKNAME' or 'botnick: seen NICKNAME' in a
+channel with the bot, the plugin answers with the last action NICKNAME
+did. There can be an exclamation mark before the word 'seen'.
 
 INSTALLATION
 
@@ -23,7 +28,7 @@ This module requires these other modules and libraries:
 
 COPYRIGHT AND LICENCE
 
-Copyright (C) 2013,2014 by Marius Gavrilescu
+Copyright (C) 2013-2015 by Marius Gavrilescu
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.14.2 or,
diff --git a/lib/POE/Component/IRC/Plugin/Seen.pm b/lib/POE/Component/IRC/Plugin/Seen.pm
index a8f7d80..90a13a6 100644
--- a/lib/POE/Component/IRC/Plugin/Seen.pm
+++ b/lib/POE/Component/IRC/Plugin/Seen.pm
@@ -100,11 +100,21 @@ POE::Component::IRC::Plugin::Seen - PoCo-IRC plugin that remembers seeing people
   my $irc = POE::Component::IRC->spawn;
   $irc->plugin_add(Seen => POE::Component::IRC::Plugin::Seen->new(filename => 'mycache.db'));
 
+  # In chat
+  # <mgv> Hi there!
+  # <foo> !seen mgv
+  # <bot> I last saw mgv [DATE] on channel #whatever saying Hi there!
+
 =head1 DESCRIPTION
 
-POE::Component::IRC::Plugin::Seen is a PoCo-IRC plugin that remembers what each person around it did last.
+POE::Component::IRC::Plugin::Seen is a PoCo-IRC plugin that remembers
+what each person around it did last. It remembers public messages,
+joins and parts.
 
-When somebody sends him a private message of the form 'seen NICKNAME' or somebody says 'botnick: seen NICKNAME' in a channel with the bot, the plugin answers with the last action NICKNAME did.
+When somebody sends him a private message of the form 'seen NICKNAME'
+or somebody says 'seen NICKNAME' or 'botnick: seen NICKNAME' in a
+channel with the bot, the plugin answers with the last action NICKNAME
+did. There can be an exclamation mark before the word 'seen'.
 
 =head1 METHODS
 
@@ -112,9 +122,12 @@ When somebody sends him a private message of the form 'seen NICKNAME' or somebod
 
 =item B<new>([I<filename> => value])
 
-Creates a new plugin object suitable for L<POE::Component::IRC>'s C<plugin_add> method.
+Creates a new plugin object suitable for L<POE::Component::IRC>'s
+C<plugin_add> method.
 
-Takes one optional argument, C<filename>, the name of the file to store the plugin's state in. If C<undef> or not given, it keeps the state in memory.
+Takes one optional argument, C<filename>, the name of the file to
+store the plugin's state in. If C<undef> or not given, it keeps the
+state in memory.
 
 =back
 
@@ -128,7 +141,7 @@ Marius Gavrilescu C<< <marius@ieval.ro> >>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2013,2014 by Marius Gavrilescu
+Copyright (C) 2013-2015 by Marius Gavrilescu
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.14.2 or,