git-feats

git-feats is a command line wrapper for git that allows you to complete feats based on your git usage.

Installation

$ gem install git-feats

git-feats is is best aliased as git, so you can type $ git <command> as you normally would and complete feats.

See alias for instructions.

Usage

With alias

If you alias git-feats, just keep using git like you always have. Occasionally, you will complete feats and it will look like this:

$ git status

********************************************************************************
                                Feat Completed!                                 
                                 Status Report                                  
                 Viewed the working tree status with git status                 
********************************************************************************

# On branch master
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#   modified:   README.md
#
no changes added to commit (use "git add" and/or "git commit -a")

Without alias

If you don't alias git to git-feats you can still use git-feats in place of git:

$ git-feats status

git-feats commands

git-feats also has commands that git-feats specific and don't mess with git.

$ git feats

usage: git feats <command>

commands:
  update  Update your feats and command history on gitfeats.com
  help    Display git-feats specific help

Alias

Add the following to your .bash_profile or other startup script:

alias git=git-feats

.com

git-feats has a sweet web frontend at gitfeats.com.

Linking your account is as easy as:

git config --global github.user <your github username>

git config --global feats.key <your api key>

Credits

git-feats was lovingly developed by:

git-feats was inspired by git-achievements.

Contributing

git-feats has a dead simple interface for making feats.

Simply add a feat to the feats file and it will work in the gem.

If you are looking to contribute, that is a great place to start.

Also, git-feats needs the following:

Tests (probably RSpec)
Code Cleanup

Any suggestions are also welcomed with open arms. Please fork, send pull requests and make issues.

How to contribute

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Copyright

See LICENSE for details.