From cf84d1d547b4a91bf269104aa7418d4ad52fd8ea Mon Sep 17 00:00:00 2001 From: Sam Gleske Date: Fri, 1 Jun 2018 17:49:11 -0700 Subject: [PATCH] Update README --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f07799a..9198270 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# git-identity-manager -Manage different git identities on your computer. Good for modifying user, name, and private key for Git. +# Git Identity Manager + +Ever find that managing multiple git identities is a pain? This git transport +attempts to make it less painful. + +![Knowing who you are can be painful][backpain] + +[Image credit PBS.org][pbs] + +# Installation + +Add `git-idm` script to your `$PATH` and make it executable. Then, you can +access the script via `git idm`. See `git idm help` for usage. + +# Uninstall + + git idm uninstall + +# Quick start + +Add your first identity. + git idm add jcool --name "Joe Cool" --email joe@example.com --key ~/.ssh/id_rsa + +Activate your identity. + + git idm use jcool + +Show which identity is active. + + git idm active + +List all known identities. + + git idm list + +For more commands see `git help idm`. + +# License + +[MIT License](LICENSE.txt) + +[backpain]: https://user-images.githubusercontent.com/875669/40868569-f1512a4e-65c2-11e8-9dfe-91ece96d62db.jpg +[pbs]: https://www.pbs.org/newshour/health/back-pain-industry-taking-patients-unhealthy-ride