Skip to content

Commit dbdf82b

Browse files
docs: update info relating to fetchtask command
1 parent 7a87180 commit dbdf82b

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,26 @@
3131

3232
## How to use
3333

34-
Users are required to solve 30 tasks that take them through the basic constructs of the programming language of their choice. The tasks are designed in such a way that the complexity increases as users progress through the tasks. Users can't move forward until the current task is completed (since the progress is determined by a unique key that is generated upon successful completion). Previously submitted tasks can be viewed as desired by the user but can't be worked on again.
34+
Users are required to solve 30 tasks that take them through the basic constructs of the programming language of their choice. The tasks are designed in such a way that the complexity increases as users progress through the tasks. Users can't move forward until the current task is completed. Previously submitted tasks can be viewed as desired by the user but can't be worked on again.
3535

3636
- `teachcode` expects you to have a GitHub account. Make sure that you create one if that's not the case.
3737
- Navigate to the directory of your choice and type in `teachcode init`.
3838
- Follow the instructions as prompted.
3939
- Now type in `cd teachcode-solutions`.
40-
- Grab the initial key and type in `teachcode fetchtask <key>`.
40+
- Type in `teachcode fetchtask`.
4141
- Hurray :tada: you've got your first task.
4242
- Now you can find a `config.json` and `task1.py` (language of choice) file within the `teachcode-solutions` directory.
4343
- Open up your favourite editor and code up the solution.
4444
- Now type in `teachcode submit`.
4545
- Enter your Git credentials when prompted.
46-
- If the current solution satisfies all test cases, you'll get the key to proceed with.
47-
- Grab the key and type in `teachcode fetchtask <key>`.
46+
- Fetch the next task with `teachcode fetchtask`.
4847

4948
## Available Commands
5049

5150
| command | description |
5251
| -------------- | ---------------- |
5352
| teachcode init | Initializes all the tasks |
54-
| teachcode fetchtask <key> | Fetches the task correponding to key provided |
53+
| teachcode fetchtask [key] | Fetches the task correponding to key if provided (defaults to the very next task) |
5554
| teachcode submit | Submits the current task |
5655
| teachcode showkeys | Shows all the keys grabbed |
5756
| teachcode showcommands | Lists all the available commands |

bin/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ program
3131

3232
program
3333
.command('fetchtask [key]')
34-
.description('Fetches any task as per the key supplied')
34+
.description('Fetch tasks to be worked upon')
3535
.action(fetchTask);
3636

3737
program

0 commit comments

Comments
 (0)