README.md in gistribute-0.0.1 vs README.md in gistribute-0.1

- old
+ new

@@ -13,44 +13,32 @@ $ gem install gistribute ## How It Works -Gistribute looks at the files in each Gist and checks for one or two lines of -metadata at the top of the file. The metadata must begin with ```%%```, but -you may put anything before that and it won't be parsed. +Gistribute looks at the filename that you enter on Gist to find all of the +data that it needs to download the file to the other user's computer. It +allows you to choose what Gistribute will call the file when it is installing +it, and where it will install the file. -The first line of metadata contains the location on the client's computer that -you wish to install the file to. The second contains the name of the file as it -will be printed on the user's screen as it is installed. If the second line is -excluded, Gistribute will use the name of the file in the Gist. - ## Usage -An example follows: +If, for example, you were sharing a .vimrc file, and you wanted Gistribute to +call it "Vim configuration" when it was installing it, you would name the file +`Vim configuration||~|.vimrc`. If the filename contains the sequence `||`, +anything before that will be considered the description of that file, and +anything after it the installation path. If there is no `||`, Gistribute will +use the name of the file (without the path to it) as the default description. -```VimL -"%% ~/.vimrc -"%% Vim configuration -" This is an example .vimrc file being shared via Gistribute. -" Notice the two comments at the top containing the metadata. +The file path separator is the pipe character because GitHub Gist doesn't +allow slashes in filenames- this quirk is the result of Gist actually saving +those files to a Git repository on their servers, and handling slashes in +file names can't possibly be very nice. -set nocompatible -filetype indent plugin on -syntax on -``` - -If, for example, the resulting Gist link was https://gist.github.com/123456, +If the resulting Gist link was, for example, https://gist.github.com/123456, the user would be able to run either of these commands to download the file -to ```~/.vimrc```: +to `~/.vimrc`: - $ gistribute 123456 - $ gistribute https://gist.github.com/123456 - -**Gistribute will strip the metadata from the files.** Don't worry about having -messy files on the user's computer because of the metadata sitting at the top, -as this is taken care of. Be aware, however, that if you leave a blank line -between the metadata and the first line of the file, the resulting downloaded -file **will** have a blank line at the top. - -If there are files in the Gist without metadata, they will be ignored by -Gistribute. +```Shell +$ gistribute 123456 +$ gistribute https://gist.github.com/123456 +```