Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added README and LICENSE files, cleaned up documentation inside bash …

…script.
  • Loading branch information...
commit fd37e37d3a42b2594aae34c6147258cc8720de82 1 parent b20e97a
@bobthecow authored
Showing with 101 additions and 20 deletions.
  1. +22 −0 LICENSE
  2. +48 −0 README.markdown
  3. +31 −20 git-flow-completion.bash
View
22 LICENSE
@@ -0,0 +1,22 @@
+Copyright (c) 2010 Justin Hileman
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
View
48 README.markdown
@@ -0,0 +1,48 @@
+git-flow-completion
+===================
+
+Bash completion support for [Git Flow](http://github.com/nvie/gitflow)
+
+The contained completion routines provide support for completing:
+
+ * git-flow init and version
+ * feature, hotfix and release branches
+ * remote feature branch names (for `git-flow feature track`)
+
+
+Installation
+------------
+
+To achieve git-flow completion nirvana:
+
+ 0. Install git-completion.
+
+ 1. Install this file. Either:
+
+ a. Place it in a `bash-completion.d` folder:
+
+ * /etc/bash-completion.d
+ * /usr/local/etc/bash-completion.d
+ * ~/bash-completion.d
+
+ b. Or, copy it somewhere (e.g. ~/.git-flow-completion.sh) and put the following line in
+ your .bashrc:
+
+ source ~/.git-flow-completion.sh
+
+ 3. Edit git-completion.sh and add the following line to the giant $command case in _git:
+
+ flow) _git_flow ;;
+
+
+Requirement 3 will go away as soon as I figure out how to properly (and predictably) hijack
+the `complete -F` ownership for `git` without breaking regular `git-completion`...
+
+
+
+The Fine Print
+--------------
+
+Copyright (c) 2010 [Justin Hileman](http://justinhileman.com)
+
+Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/)
View
51 git-flow-completion.bash
@@ -1,42 +1,53 @@
#!bash
#
-# bash completion support for Git Flow (http://github.com/nvie/gitflow)
-#
-# Copyright (c) 2010 Justin Hileman (http://justinhileman.com)
-# Distributed under the MIT License (http://creativecommons.org/licenses/MIT/)
-#
-#
+# git-flow-completion
+# ===================
+#
+# Bash completion support for [Git Flow](http://github.com/nvie/gitflow)
+#
# The contained completion routines provide support for completing:
-#
+#
# * git-flow init and version
# * feature, hotfix and release branches
# * remote feature branch names (for `git-flow feature track`)
-#
-#
+#
+#
+# Installation
+# ------------
+#
# To achieve git-flow completion nirvana:
-#
+#
# 0. Install git-completion.
-#
+#
# 1. Install this file. Either:
-#
+#
# a. Place it in a `bash-completion.d` folder:
-#
+#
# * /etc/bash-completion.d
# * /usr/local/etc/bash-completion.d
# * ~/bash-completion.d
-#
+#
# b. Or, copy it somewhere (e.g. ~/.git-flow-completion.sh) and put the following line in
# your .bashrc:
-#
+#
# source ~/.git-flow-completion.sh
-#
+#
# 3. Edit git-completion.sh and add the following line to the giant $command case in _git:
-#
-# flow) _git_flow ;;
-#
-#
+#
+# flow) _git_flow ;;
+#
+#
# Requirement 3 will go away as soon as I figure out how to properly (and predictably) hijack
# the `complete -F` ownership for `git` without breaking regular `git-completion`...
+#
+#
+#
+# The Fine Print
+# --------------
+#
+# Copyright (c) 2010 [Justin Hileman](http://justinhileman.com)
+#
+# Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/)
_git_flow ()
{
Please sign in to comment.
Something went wrong with that request. Please try again.