Skip to content

Commit 98e563e

Browse files
committed
Update README to include debug flag option
1 parent 9d87b3d commit 98e563e

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@ Options:
2323
-g, --github use GitHub login credentials
2424
-o, --output <path> path to the output directory where solutions will be saved (default: <YOUR_HOME_DIRECTORY>/my_codewars_solutions)
2525
-v, --verbose explain what is being done
26+
-d, --debug run the scraper in debug mode (will make browser window appear to see what is being done)
2627
-u, --username <username> your CodeWars username
2728
-e, --email <email> your GitHub or CodeWars account email
2829
-p, --password <password> your GitHub or CodeWars account password
2930
-h, --help display help for command
3031
```
3132

32-
* NOTE: `-c` and `-g` options are mutually exclusive.
33+
- NOTE: `-c` and `-g` options are mutually exclusive.
3334

3435
## Examples
3536

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

6869
## Built With
6970

70-
* [Puppeteer](https://pptr.dev)
71-
* [Commander](https://www.npmjs.com/package/commander)
72-
* [Inquirer](https://www.npmjs.com/package/inquirer)
73-
* [Chalk](https://www.npmjs.com/package/chalk)
71+
- [Puppeteer](https://pptr.dev)
72+
- [Commander](https://www.npmjs.com/package/commander)
73+
- [Inquirer](https://www.npmjs.com/package/inquirer)
74+
- [Chalk](https://www.npmjs.com/package/chalk)
7475

7576
## License
7677

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codewars-solutions-scraper",
3-
"version": "1.0.5",
3+
"version": "1.0.6",
44
"description": "A scraper that gets the solutions of all of the CodeWars katas you have solved",
55
"main": "src/main.js",
66
"bin": {

0 commit comments

Comments
 (0)