Permalink
Browse files

add readme

  • Loading branch information...
1 parent fd1f5b9 commit 8d1a666d609ad0cbbab7f07ea2775b38f929ac63 @ryanbriones committed Oct 28, 2008
Showing with 33 additions and 2 deletions.
  1. +31 −0 README.markdown
  2. +1 −1 Rakefile
  3. +1 −1 git-pair.gemspec
View
@@ -0,0 +1,31 @@
+# git-pair
+
+* Code: [http://github.com/ryanbriones/git-pair](http://github.com/ryanbriones/git-pair)
+
+# Description
+
+I wanted a way for git to show me when a commit was made from a pair during pair programming. As usual, git provides a mechanism for the concept using the --author option on git commit. Inspired by [Bryan Helpkamp's git pairing script] [1] I wanted git-pair to have a list of authors that was loaded from outside the script. Git, being amazingly flexible, allowed me to store information about authors in the git config and access the information uniformly. And so it is.
+
+[1]: http://www.brynary.com/2008/9/1/setting-the-git-commit-author-to-pair-programmers-names
+
+# Install
+
+## Using GitHub's gem repo
+ sudo gem install ryanbriones-git-pair --source=http://gems.github.com
+
+## From source
+ git clone git://github.com/ryanbriones/git-pair.git
+ cd git-pair
+ rake
+ sudo gem install --local pkg/git-pair-X.X.X.gem
+
+# Usage
+
+* Add an author: `git-pair add abbr 'Person <emailaddress>'`
+ * example: `git-pair add js 'John Smith <jsmith@example.com>'`
+* Show available authors: `git-pair show`
+* Commit with a pair: `git-pair commit [abbr] [-m 'Commit Message']`
+
+# Authors
+
+* [Ryan Carmelo Briones &lt;ryan.briones@brionesandco.com&gt;](mailto:ryan.briones@brionesandco.com)
View
@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
spec = Gem::Specification.new do |s|
s.name = 'git-pair'
- s.version = '0.0.1'
+ s.version = '0.0.2'
s.summary = 'Simple interface for adding your pair to a commit via git commit --author'
s.files = FileList['[A-Z]*', 'bin/*', 'lib/**/*']
s.has_rdoc = false
View
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
s.default_executable = %q{git-pair}
s.email = %q{ryan.briones@brionesandco.com}
s.executables = ["git-pair"]
- s.files = ["Rakefile", "bin/git-pair", "lib/git-pair", "lib/git-pair/author.rb", "lib/git-pair/command.rb", "lib/git-pair/commit.rb"]
+ s.files = ["Rakefile", "README.markdown", "bin/git-pair", "lib/git-pair", "lib/git-pair/author.rb", "lib/git-pair/command.rb", "lib/git-pair/commit.rb"]
s.homepage = %q{http://brionesandco.com/ryanbriones}
s.require_paths = ["lib"]
s.rubygems_version = %q{1.2.0}

0 comments on commit 8d1a666

Please sign in to comment.