Skip to content

Commit

Permalink
Update --help and readme with --list flag command
Browse files Browse the repository at this point in the history
  • Loading branch information
rkotze committed Sep 12, 2018
1 parent 27575db commit d358d73
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ $ git solo
Jane Doe <[email protected]>
```

Check which co-authors you have available in your `.git-coauthors` file.

```
$ git mob --list
jd Jane Doe [email protected]
ad Amy Doe [email protected]
bd Bob Doe [email protected]
```

<sup>\* [If you have git-duet installed, you'll need to uninstall it](https://github.com/findmypast-oss/git-mob/issues/2) since it conflicts with the git-solo command.</sup>

Find out more with `git mob --help`
1 change: 1 addition & 0 deletions bin/mob.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const argv = minimist(process.argv.slice(2), {
alias: {
h: 'help',
v: 'version',
l: 'list'
},
});

Expand Down
2 changes: 2 additions & 0 deletions src/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ function runHelp() {
Options
-h Prints usage information
-v Prints current version
-l Prints list of available co-authors
Examples
$ git mob jd # Set John Doe as co-author
$ git mob jd am # Set John & Amy as co-authors
$ git mob -l # Show a list of all co-authors
$ git solo # Dissipate the mob
`;
console.log(message);
Expand Down

0 comments on commit d358d73

Please sign in to comment.