diff --git a/README.md b/README.md index 4b86085..3901689 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +**Gas is the Git Author Switcher.** Do you have a personal and a work email and use the same computer to commit? Try gas to help you switch between the two. +Do you pair program and want to reflect that it's not only you writing the code? Use gas to switch between you and your partner's commiter. + +Gas is extensible. + -
- -Gas helps you manage your git authors. Do you have a personal and a work email and use the same computer to commit. Try gas to help you switch between the two. -Do you pair program and want to reflect that it's not only you writing the code, try gas to switch between your pair user and your regular. - -Gas is extensible and it's easy to extend with any functionality you may want. - ## Get it -The best way to install gas is with RubyGems: +The best way to install gas is with `gem`: - $ [sudo] gem install gas + $ sudo gem install gas -You can install from source: +You can also install it from source: $ cd gas/ $ bundle @@ -36,15 +34,13 @@ You can install from source: ## Use it -### Built-in commands - -* add NICKNAME NAME EMAIL - adds a new user to gas -* delete NICKNAME - deletes a user from gas -* import NICKNAME - imports the user from .gitconfig into NICKNAME -* list - lists all users -* plugins - lists all installed plugins -* show - shows the current user -* use NICKNAME - sets the user with NICKNAME as the current user +* `add PROFILE NAME EMAIL` - adds a new user to gas +* `delete PROFILE` - deletes a user from gas +* `import PROFILE` - imports the user from .gitconfig into PROFILE +* `list` - lists all users +* `plugins` - lists all installed plugins +* `show` - shows the current user +* `use PROFILE` - sets the user with PROFILE as the current user The default task is to list authors @@ -54,7 +50,7 @@ The default task is to list authors This lists the authors that are set up in the ~/.gas/gas.users file. -You can import your current user by giving it a nickname +You can import your current user by giving it a PROFILE $ gas import current_user @@ -84,31 +80,32 @@ To extend already existing commands make an executable with the name gas-yourplu This makes it possible to extend plugins too eg. gas-myplugin-stats will extend the stats command, if installed. An example plugin exists at https://github.com/walle/gas_stats it's written in ruby, and distributed with rubygems. But this is not a requirement. -It extends gas both with adding functionality to built-in commands(counting statistics) and adding own functionality(gas-stats). + +Some plugins extend gas by adding functionality to built-in commands (ex. gas-stats) as well as by adding its own functionality (ex. gas-ssh). ## Plugins ### Available plugins -#### gas_stats +#### gas\_stats Shows usage statistics for gas. Serves as a reference implementation of a plugin. Code: https://github.com/walle/gas_stats -Installation: $ gem install gas_stats +Installation: `$ gem install gas_stats` Author: [Fredrik Wallgren](https://github.com/walle) -#### gas_ssh +#### gas\_ssh Adds ssh support for gas. -Work in progress right now. +Currently a work in progress. -Code: https://github.com/TheNotary/gas_ssh +Code: https://github.com/TheNotary/gas\_ssh -Installation: $ gem install gas_ssh +Installation: `$ gem install gas_ssh` Author: [TheNotary](https://github.com/TheNotary)