Skip to content

Commit

Permalink
Merge pull request #85 from davidalpert/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidalpert authored Sep 28, 2022
2 parents 45f639f + 96cf761 commit da04104
Showing 1 changed file with 28 additions and 15 deletions.
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,37 +126,50 @@ Visit the [Releases](https://github.com/davidalpert/go-git-mob/releases) page to

### Verify your installation

1. Confirm that git recognizes the `git-mob` plugin:
```
git mob version
```
Confirm that git recognizes the `git-mob` plugin:

With `git-mob` installed that command displays the plugin version:
```
git-mob 0.5.1+f5536c2
```
```
> git mob version
git-mob 0.5.1+f5536c2
```

### Post-install steps

1. Install helper plugins [once per machine]:
1. Install helper plugins [once per machine]

```
git mob rehash
```

`git-mob` ships as a single-file executable. The `rehash` sub-command generates simple shell scripts to make the following helper plugins available:
- The `rehash` sub-command generates simple shell scripts to make the following git plugin helpers available:

```
git mob-print
git mob-version
git solo
git suggest-coauthors
```

2. Add some co-authors

```
git mob-print
git mob-version
git solo
git suggest-coauthors
git add-coauthor jd "Jane Doe" "jane@example.com"
```

1. Initialize `prepare-commit-msg` hook script [once per repository]:
3. List available co-authors

```
git mob --list
```

4. Initialize `prepare-commit-msg` hook script [once per repository]:

```
git mob init
```

`git-mob` uses a configuration file called `~/.git-coauthors` to store available coauthors by initials

### Add initials of the current mob to your prompt

#### Zsh with `Powerlevel10k`
Expand Down

0 comments on commit da04104

Please sign in to comment.