added example on Tak Use

[scpubgit/Tak.git] / lib / Tak.pm

diff --git a/lib/Tak.pm b/lib/Tak.pm
index b77a770..7258b73 100644 (file)
--- a/lib/Tak.pm
+++ b/lib/Tak.pm
@@ -85,6 +85,43 @@ A drink leaked in my bag on the way back from LPW. My laptop is finally
 alive again though so I'll try and turn my slides into a vague attempt
 at documentation while I'm traveling to/from christmas things.
 
+=head1 Example
+
+$ cat Takfile
+package Tak::MyScript;
+
+use strict;
+use warnings;
+
+use Tak::Takfile;
+use Tak::ObjectClient;
+use lib "./lib";
+
+sub each_host {
+    my ($self, $remote) = @_;
+
+    my $oc = Tak::ObjectClient->new(remote => $remote);
+    my $name = $oc->new_object('My::Hostname');
+    print "Connected to hostname: " . $name . "\n";
+    }
+
+1;
+
+-----
+
+$cat ./lib/My/Hostname
+package My::Hostname;
+
+use Sys::Hostname;
+
+sub new {
+    my ($self) = @_;
+    my $name = hostname;
+    return $name;
+    }
+
+1;
+
 =head1 AUTHOR
 
 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>