Skip to content

Commit

Permalink
Update README to include debug flag option
Browse files Browse the repository at this point in the history
  • Loading branch information
nibble-4bits committed Nov 29, 2020
1 parent 9d87b3d commit 98e563e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ Options:
-g, --github use GitHub login credentials
-o, --output <path> path to the output directory where solutions will be saved (default: <YOUR_HOME_DIRECTORY>/my_codewars_solutions)
-v, --verbose explain what is being done
-d, --debug run the scraper in debug mode (will make browser window appear to see what is being done)
-u, --username <username> your CodeWars username
-e, --email <email> your GitHub or CodeWars account email
-p, --password <password> your GitHub or CodeWars account password
-h, --help display help for command
```

* NOTE: `-c` and `-g` options are mutually exclusive.
- NOTE: `-c` and `-g` options are mutually exclusive.

## Examples

Expand Down Expand Up @@ -67,10 +68,10 @@ codewars-solutions-scraper -g -o /path/to/custom/dir -u <YOUR_CODEWARS_USERNAME>

## Built With

* [Puppeteer](https://pptr.dev)
* [Commander](https://www.npmjs.com/package/commander)
* [Inquirer](https://www.npmjs.com/package/inquirer)
* [Chalk](https://www.npmjs.com/package/chalk)
- [Puppeteer](https://pptr.dev)
- [Commander](https://www.npmjs.com/package/commander)
- [Inquirer](https://www.npmjs.com/package/inquirer)
- [Chalk](https://www.npmjs.com/package/chalk)

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "codewars-solutions-scraper",
"version": "1.0.5",
"version": "1.0.6",
"description": "A scraper that gets the solutions of all of the CodeWars katas you have solved",
"main": "src/main.js",
"bin": {
Expand Down

0 comments on commit 98e563e

Please sign in to comment.