Permalink
Browse files

improve docs

  • Loading branch information...
1 parent 854970f commit 620578ad0483d3ec23247c05461b272bde73c13b @ghedo committed Mar 24, 2013
Showing with 13 additions and 15 deletions.
  1. +11 −8 bin/gist
  2. +2 −7 lib/App/gist.pm
View
@@ -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
View
@@ -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

0 comments on commit 620578a

Please sign in to comment.