Skip to content

Commit

Permalink
Add missing options in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kamranahmedse committed Feb 20, 2020
1 parent b245439 commit c32f3cd
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ git standup [-a <author name>]
[-w <weekstart-weekend>]
[-m <max-dir-depth>]
[-F]
[-b]
[-b <branch-to-use>]
[-d <since-days-ago>]
[-u <until-days-ago>]
[-D <date-format>]
Expand Down Expand Up @@ -140,6 +140,13 @@ If you want to find out someone else's commits do
# Considering their name on git is "John Doe"
$ git standup -a "John Doe"
```

Apart fromm restrict to commits from a certain user, you can also use `-a` flag to avoid certain users. You can do that if you enable perl regexp in your git installation `git config --global grep.patternType perl`, and use the author filter like below:

```shell
git standup -a'^(?!(renovate\[bot\]))'
```

![git standup](http://i.imgur.com/sYICxW8.gif)

## Check what every contributor did
Expand Down Expand Up @@ -205,6 +212,15 @@ $ git standup -D relative
# Or instead of relative, it could be local|default|iso|iso-strict|rfc|short|raw etc
```

## Branch Filter

Use of `-b foobar` option, which restricts returned results to commits present on branch `foobar`. Supports arbitrary branch specs, so for example `-b origin/foobar` would include data present on the remote that has not been merged locally.

```shell
# Use develop branch for standup
git standup -b develop
```

## Changing the Weekdays

By default, it considers that the work week starts on Monday and ends on Friday. So if you are running this on any day between Tuesday and Friday, it will show you your commits from the last day. However, if you are running this on Monday, it will show you all your commits since Friday.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "git-standup",
"version": "2.3.1",
"version": "2.3.2",
"description": "Recall what you did on the last working day. Psst! or be nosy and find what someone else in your team did ;-)",
"main": "",
"scripts": {
Expand Down

0 comments on commit c32f3cd

Please sign in to comment.