diff options
| author | Tom Ryder <tom@sanctum.geek.nz> | 2017-10-14 02:37:02 +1300 |
|---|---|---|
| committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-10-14 02:37:02 +1300 |
| commit | 4f74ecbe12f6cdef30795374c3cba176cc29c595 (patch) | |
| tree | 995cc99db80b0827301d6c8aea8efb39155317fc /README.markdown | |
| parent | Perl::Tidy run over bin/runcrypt (diff) | |
| download | Mail-Run-Crypt-4f74ecbe12f6cdef30795374c3cba176cc29c595.tar.gz Mail-Run-Crypt-4f74ecbe12f6cdef30795374c3cba176cc29c595.zip | |
Make SYNOPSIS more useful/complete
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/README.markdown b/README.markdown index 8d9187d..5327928 100644 --- a/README.markdown +++ b/README.markdown @@ -26,12 +26,20 @@ via environment variables or command-line options. # SYNOPSIS + use Mail::Run::Crypt; + ... my $mrc = Mail::Run::Crypt->new( + mailto => 'you@example.net', + ); + $mrc->run($command, @args); + ... + my $mrc = Mail::Run::Crypt->new( + sign => 1, keyid => 0x1234DEAD, passphrase => 'able was i ere i saw elba', mailto => 'you@example.net', ); - $mrc->run(qw(rsync -a /mnt/a/ remote:mnt/b)); + $mrc->run($command, @args); # SUBROUTINES/METHODS |