Skip to content

Commit

Permalink
update README usage
Browse files Browse the repository at this point in the history
  • Loading branch information
kvnxiao authored Apr 30, 2019
1 parent d6e4361 commit 02eb1f9
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,13 @@ Creates an executable file called `sort-awesome-lists` in your directory. Run in

```
Usage of sort-awesome-lists:
-bs int
number of concurrent requests to send to GitHub API at a time, per each block found. (default 5)
-o string
name of file to write output to if set, otherwise prints to stdout
-t string (REQUIRED)
-t string
GitHub personal access token
-v prints debug messages to stdout if true
-v prints debug messages to stdout if true (default = false)
```

A GitHub personal access token is **required** by the `-t` flag as this CLI application hits the GitHub API for repository statistics. The token allows one to access the GitHub API at a rate-limit of 5000 requests per hour. A personal access token with 0 permissions checked can be generated and used (go here to create one if you don't already have one: https://github.com/settings/tokens)
Expand Down

0 comments on commit 02eb1f9

Please sign in to comment.