Skip to content

Commit cf84d1d

Browse files
committed
Update README
1 parent 1693441 commit cf84d1d

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# git-identity-manager
2-
Manage different git identities on your computer. Good for modifying user, name, and private key for Git.
1+
# Git Identity Manager
2+
3+
Ever find that managing multiple git identities is a pain? This git transport
4+
attempts to make it less painful.
5+
6+
![Knowing who you are can be painful][backpain]
7+
8+
[Image credit PBS.org][pbs]
9+
10+
# Installation
11+
12+
Add `git-idm` script to your `$PATH` and make it executable. Then, you can
13+
access the script via `git idm`. See `git idm help` for usage.
14+
15+
# Uninstall
16+
17+
git idm uninstall
18+
19+
# Quick start
20+
21+
Add your first identity.
22+
git idm add jcool --name "Joe Cool" --email joe@example.com --key ~/.ssh/id_rsa
23+
24+
Activate your identity.
25+
26+
git idm use jcool
27+
28+
Show which identity is active.
29+
30+
git idm active
31+
32+
List all known identities.
33+
34+
git idm list
35+
36+
For more commands see `git help idm`.
37+
38+
# License
39+
40+
[MIT License](LICENSE.txt)
41+
42+
[backpain]: https://user-images.githubusercontent.com/875669/40868569-f1512a4e-65c2-11e8-9dfe-91ece96d62db.jpg
43+
[pbs]: https://www.pbs.org/newshour/health/back-pain-industry-taking-patients-unhealthy-ride

0 commit comments

Comments
 (0)