Add README and inline POD for script.

1 files changed, 60 insertions, 0 deletions

diff --git a/bin/smsg b/bin/smsg
index 6b3723d..d185686 100755
--- a/bin/smsg
+++ b/bin/smsg
@@ -2,3 +2,63 @@
 
 use App::smsg;
 App::smsg->run;
+
+__END__
+
+=head1 NAME
+
+smsg - utilities for short messages
+
+=head1 SYNOPSIS
+
+Wanna chat with a silly bot in some Jabber chatroom?
+
+ $ smsg talk bot@example.org foo talkfile.txt room1@muc.example.org
+ connecting to bot@example.org...
+
+=head1 DESCRIPTION
+
+smsg is a command-line tool which provides a handful of helpful
+utilities for short messages. For example, reporting on the status of a
+Kannel server or a Jabber server; passing messages between them;
+mirroring messages processed on a Kannel server in a Jabber chatroom,
+and so on.
+
+This is an early version, so the number of utilities provided is fairly
+limited, but will grow. Thanks to L<App::Cmd>, smsg has a modular
+architecture, so you can write your own App::smsg plugins, and publish
+them on CPAN.
+
+For a list of supported commands, run:
+
+ $ smsg commands
+
+For help on a particular command, e.g. the "talk" command, run:
+
+ $ smsg help talk
+
+=head1 BUGS
+
+Please report any bugs to
+E<lt>dr@jones.dkE<gt>.
+
+=head1 SEE ALSO
+
+L<App::smsg>.
+
+=head1 AUTHOR
+
+Jonas Smedegaard E<lt>dr@jones.dkE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Jonas Smedegaard.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=head1 DISCLAIMER OF WARRANTIES
+
+THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.