Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

improve docs

  • Loading branch information...
commit 620578ad0483d3ec23247c05461b272bde73c13b 1 parent 854970f
Alessandro Ghedini authored March 25, 2013

Showing 2 changed files with 13 additions and 15 deletions. Show diff stats Hide diff stats

  1. 19  bin/gist
  2. 9  lib/App/gist.pm
19  bin/gist
@@ -7,7 +7,7 @@ use App::gist;
7 7
 
8 8
 =head1 NAME
9 9
 
10  
-gist - GitHub Gist creator
  10
+gist - Gist command-line tool
11 11
 
12 12
 =cut
13 13
 
@@ -15,15 +15,18 @@ gist - GitHub Gist creator
15 15
 
16 16
  gist [OPTIONS] FILE
17 17
 
18  
- Options:
19  
-   --description, -d  DESCRIPTION
20  
-   --update, -u       GIST_ID
21  
-   --private, -p
22  
-   --web, -w
  18
+=over
  19
+
  20
+=item Create a new gist from a file
23 21
 
24  
- Examples:
25 22
    $ gist script.pl
26  
-   $ cat script | gist
  23
+
  24
+=item Create a new gist from a pipe with a description
  25
+
  26
+   $ cat script | gist -d 'some script'
  27
+
  28
+=item Create a new gist and copy the web URL in the clipboard
  29
+
27 30
    $ echo "something" | gist -w | xclip
28 31
    $ echo "something" | gist -w | pbcopy # on Mac OS X
29 32
 
9  lib/App/gist.pm
@@ -11,16 +11,11 @@ use Class::Load qw(try_load_class);
11 11
 
12 12
 =head1 NAME
13 13
 
14  
-App::gist - Command-line GitHub's gist client
  14
+App::gist - Gist command-line tool
15 15
 
16 16
 =head1 SYNOPSIS
17 17
 
18  
-    use App::gist;
19  
-
20  
-    use strict;
21  
-    use warnings;
22  
-
23  
-    App::gist -> run;
  18
+   $ gist script.pl
24 19
 
25 20
 =cut
26 21
 

0 notes on commit 620578a

Please sign in to comment.
Something went wrong with that request. Please try again.