From b48ee68b8d99cd9c44b1d88dc1cecf9daceba415 Mon Sep 17 00:00:00 2001 From: Tj Holowaychuk Date: Sun, 27 Mar 2011 09:06:08 -0700 Subject: [PATCH] docs --- Readme.md | 14 +++++++++----- man/git-extras.1 | 3 +++ man/git-extras.html | 7 ++++++- man/git-extras.md | 4 ++++ 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/Readme.md b/Readme.md index 6a7f353..5d5739f 100644 --- a/Readme.md +++ b/Readme.md @@ -19,6 +19,7 @@ Brew (buggy): ## Commands + - git extras - git summary - git changelog - git commits-since @@ -33,11 +34,18 @@ Brew (buggy): - git contrib - git repl - git undo - - git update-extras - git gh-pages - git setup - git touch +## extras + + The main `git-extras` command, outputting the current `--version`, or listing the commands available via `--help`, or `updating` to the latest release. + +For example if you wish to update to the latest version of git-extras simply execute: + + $ git extras update + ## gh-pages Sets up the `gh-pages` branch. @@ -261,10 +269,6 @@ Remove the latest 3 commits: git undo 3 -## git-update-extras - - Updates git extras. clones the repo to _/tmp/git-extras_, make installs, then cds back to the origin directory. - ## git-setup [dir] Set up a git repository if one doesn't exist, add all files and make an initial commit. _dir_ defaults to the current working directory. diff --git a/man/git-extras.1 b/man/git-extras.1 index 05dfea3..5edcf26 100644 --- a/man/git-extras.1 +++ b/man/git-extras.1 @@ -6,6 +6,9 @@ .SH "NAME" \fBgit\-extras\fR \- Awesome GIT utilities . +.SH "SYNOPSIS" +\fBgit\-extras\fR [\-v,\-\-version] [\-h,\-\-help] [update] +. .SH "COMMANDS" . .IP "\(bu" 4 diff --git a/man/git-extras.html b/man/git-extras.html index 994b034..ea934bb 100644 --- a/man/git-extras.html +++ b/man/git-extras.html @@ -54,6 +54,7 @@