Skip to content

Commit

Permalink
Update docs for get:code-challenges (#39)
Browse files Browse the repository at this point in the history
Close #26
  • Loading branch information
bradtaniguchi authored May 14, 2022
1 parent defa657 commit f417dfd
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,26 +58,34 @@ just getting raw data directly outputted directly into stdout.

### get-user

Returns a single user.

```bash
npm run get:user <username | userId>
```

### get-completed-challenges

Returns the list of completed challenges for the given user. Includes pagination.

```bash
npm run get:completed-challenges <username | userId> [page = 0]
```

### get-authored-challenges

Returns a list of authored challenges made by the user.

```bash
npm run get:authored-challenges <username | userId>
```

### get-code-challenges
### get-code-challenge

Returns a single code challenge.

```bash
npm run get:code-challenges <challengeId | challenge-slug>
npm run get:code-challenge <challengeId | challenge-slug>
```

## Contributing
Expand Down

0 comments on commit f417dfd

Please sign in to comment.