Improved help text.

[inkarkat]

I had trouble understanding the use of gist.vim through the rudimentary help text contained in the script's header. I was missing a structure (posting vs. editing vs. listing. vs. context-sensitive commands in the buffer itself). The long arguments aren't listed at all.

Below is my stab at an improved help text. Beware, I've been using gist.vim only for a couple of hours, so my interpretation may be off! I would also recommend to split off the help text into a separate doc/gist.txt file (and then packaging the script either as Vimball or TAR/ZIP archive). This would allow translation of the help into other languages and integration with the :help command.

-- regards, ingo

POSTING                                                                      *
:[range]Gist            Post selected text / entire buffer to gist.
:Gist -p|--private      Post a private gist. If you get an empty gist list,
                        try :Gist --abandon
:Gist -a|--anonymous    Post anonymously, without using your configured login.
:Gist -m|--multibuffer  Multi buffer: Post all visible buffers concatenated. 

EDITING                                                                      *
:Gist XXXXX             Download and edit existing gist XXXXX.
:Gist -c|--clipboard XXXXX
                        Get gist XXXXX and copy the contents to the clipboard,
                        too.

LISTING                                                                      *
:Gist -l|--list [{username}]
                        List gists from {username} / my own gists. 
:Gist -la|--listall     List all gists. 

IN GIST BUFFERS                                                              *
:w                      You can update the gist with :w command in the gist
                        buffer.
:Gist -e|--edit [{name}]
                        Edit the gist, optionally passing the gist file name
                        {name}. 
:Gist -d|--delete       Delete the gist. (password authentication is needed)
:Gist -f|--fork         Fork the gist. (password authentication is needed)

 vim:tw=78:ts=8:ft=help:norl:

[ches]

Definitely wish documentation properly used the Vim help system. I occasionally forget an option and this is the only plugin in my arsenal that forces me to go open/page a file to jog my memory.

[mattn]

This is already written in :help gist-vim-usage.

Thanks.