Skip to content

Commit 2301bd9

Browse files
committed
update readme with help and usage
1 parent fa7b012 commit 2301bd9

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# git-codeowners [![Build Status](https://travis-ci.org/softprops/git-codeowners.svg?branch=master)](https://travis-ci.org/softprops/git-codeowners)
22

3+
# usage
4+
5+
git-codeowners is intended for use as a git extention ( a program whose name starts with git- ) to extend your git workflow.
6+
7+
```bash
8+
$ git codeowners src/main.rs
9+
@softprops
10+
```
11+
12+
```bash
13+
$ git-codeowners --help
14+
git-codeowners 0.1.0
15+
Github CODEOWNERS answer sheet
16+
17+
USAGE:
18+
git-codeowners [FLAGS] [OPTIONS] <path>
19+
20+
FLAGS:
21+
-e, --emails Only return emails
22+
-h, --help Prints help information
23+
-t, --teams Only return teams
24+
-u, --users Only return users
25+
-V, --version Prints version information
26+
27+
OPTIONS:
28+
-c, --codeowners <codeowners> An explicit path for a CODEOWNERS file. program will exit 1 if file can not be resolved
29+
30+
ARGS:
31+
<path> Path of file in git repo. if '-' is provided path will be read from stdin. program will exit 2 if no owners can be resolved
32+
```
33+
334
Doug Tangren (softprops) 2017

0 commit comments

Comments
 (0)