Skip to content

Commit 18b942d

Browse files
docs(reporting): add usage into README.md
1 parent 0f72f11 commit 18b942d

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

reporting/README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,23 @@ For launching the reporting script, you will need a github & twitter token.
55

66
You can find these tokens in the following links:
77
- twitter: https://developer.twitter.com/en/docs/authentication/oauth-2-0
8-
- github: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token
8+
- github: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token
9+
10+
## Usage
11+
12+
```bash
13+
USAGE
14+
reporting [flags]
15+
16+
FLAGS
17+
-backlog=true generate backlog
18+
-changelog=true generate changelog
19+
-curation=true generate curation
20+
-format markdown output format
21+
-github-token ... github token
22+
-help=false show help
23+
-output-path ./output/ output directory path
24+
-since ... since date RFC 3339 (ex: 2003-01-19T00:00:00.000Z)
25+
-tips=true generate tips
26+
-twitter-token ... twitter token
27+
```

0 commit comments

Comments
 (0)