Skip to content

Commit 9067708

Browse files
committed
update readme
1 parent 2dce3bc commit 9067708

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# Standup-rs
22

3-
```
4-
Generate a report for morning standup using Github.
3+
Generate a report for morning standup using Github events.
4+
5+
## Features
6+
7+
- Supported events:
8+
- PRs: opened, merged, reviewed
9+
- Issues: opened, commented (optional, disable by default)
10+
- Shortcuts for --since flag
11+
- Copy-paste-able output for Slack
12+
- Private repos are covered
13+
14+
## Install
515

16+
Go to [releases page](https://github.com/smacker/standup-rs/releases) and download a binary for your platform.
17+
18+
## Usage
19+
20+
```
621
USAGE:
722
standup_rs [FLAGS] [OPTIONS] --token <token> --user <user>
823
@@ -18,7 +33,7 @@ OPTIONS:
1833
-l, --user <user> Github user login [env: STANDUP_LOGIN=]
1934
```
2035

21-
### Example output
36+
## Example output
2237

2338
```
2439
$ ./standup_rs -s today --issue-comments

0 commit comments

Comments
 (0)