Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ghedo committed Mar 24, 2013
1 parent 854970f commit 620578a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
19 changes: 11 additions & 8 deletions bin/gist
Expand Up @@ -7,23 +7,26 @@ use App::gist;

=head1 NAME
gist - GitHub Gist creator
gist - Gist command-line tool
=cut

=head1 SYNOPSIS
gist [OPTIONS] FILE
Options:
--description, -d DESCRIPTION
--update, -u GIST_ID
--private, -p
--web, -w
=over
=item Create a new gist from a file
Examples:
$ gist script.pl
$ cat script | gist
=item Create a new gist from a pipe with a description
$ cat script | gist -d 'some script'
=item Create a new gist and copy the web URL in the clipboard
$ echo "something" | gist -w | xclip
$ echo "something" | gist -w | pbcopy # on Mac OS X
Expand Down
9 changes: 2 additions & 7 deletions lib/App/gist.pm
Expand Up @@ -11,16 +11,11 @@ use Class::Load qw(try_load_class);

=head1 NAME
App::gist - Command-line GitHub's gist client
App::gist - Gist command-line tool
=head1 SYNOPSIS
use App::gist;
use strict;
use warnings;
App::gist -> run;
$ gist script.pl
=cut

Expand Down

0 comments on commit 620578a

Please sign in to comment.