Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs for get:code-challenges #39

Merged
merged 1 commit into from
May 14, 2022
Merged

Update docs for get:code-challenges #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
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