Skip to content
This repository was archived by the owner on Mar 31, 2022. It is now read-only.

Commit 6b6d932

Browse files
committed
Update README.md
- Uncomment `no_solo_prefix` option in example since it's more useful to have enabled - Uncomment `global` option in example but keep it disabled; also add inline comment explaining when to set to `true` - Format filepaths and usage options - Add instructions to "unpair"
1 parent a8c488a commit 6b6d932

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,22 @@ Create a `.pairs` config file in project root or your home folder.
3636
email:
3737
prefix: pair
3838
domain: pivotallabs.com
39-
# no_solo_prefix: true
40-
#global: true
39+
no_solo_prefix: true
40+
global: false # Set to true for git-pair to change git configuration for all your projects
4141

4242

43-
By default this affects the current project (.git/config).<br/>
44-
Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (~/.gitconfig).
43+
By default this affects the current project (`.git/config`).
44+
Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (`~/.gitconfig`).
4545

4646
Options are:
47+
4748
-g, --global Modify global git options instead of local
4849
-v, --version Show Version
4950
-h, --help Show this.
51+
52+
When you're done pairing, change git's configuration to use your personal details.
53+
54+
git pair <your-initials>
5055

5156
## git-pair-commit
5257

0 commit comments

Comments
 (0)