docs: update readme file (#110)

* docs: update readme file

previously the instructions lacked step-by-step clarity
on how to use the cli properly. Now have added exact steps
that a user at any level can follow easily and get started
with the learning. Have also provided appropriate doc links
wherever necessary.

fixes #109

Signed off by: Ajo John <[email protected]>

* chore: address review comments

Signed off by: Ajo John <[email protected]>

* chore: prettify

Co-authored-by: Ajo John <[email protected]>
Co-authored-by: jamesgeorge007 <[email protected]>

Author: 3 people

README.md

@@ -33,26 +33,28 @@
 
 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. One can't move forward until the current task is completed. Previously submitted tasks can be viewed if he/she wants but can't be worked on again.
 
-- `teachcode` expects you to have a GitHub account. Make sure that you create one if that's not the case.
+- `teachcode` expects you to have a GitHub account. Make sure that you create one if you don't have one. [Learn more - Github Signup](https://docs.github.com/en/github/getting-started-with-github/signing-up-for-a-new-github-account)
 - Navigate to the directory of your choice and type in `teachcode init`.
-- Follow the instructions as prompted.
+- Choose your track. Currently, we provide two tracks, Python and Javascript
+- Enter your name. We ask for your name mainly for greeting purpose.
+- Enter your GitHub username.
+- Enter your GitHub personal token with repo access. [Learn more - GitHub Personal Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
 - Now type in `cd teachcode-solutions`.
 - Type in `teachcode fetchtask`.
 - Hurray :tada: you've got your first task.
-- Now you can find a `config.json` and `task1.py` (language of choice) file within the `teachcode-solutions` directory.
-- Open up your favourite editor and code up the solution.
-- Now type in `teachcode submit`.
-- Enter your Git credentials when prompted.
+- Type in your solution for the task in the file `task1.py` (opted learning track) using any code editor of choice. We recommend using [VS Code](https://code.visualstudio.com/)
+- Now type in `teachcode submit` to submit your solution.
+- Enter your Git credentials when prompted. [Learn more - Git Credentials](https://docs.github.com/en/github/getting-started-with-github/getting-started-with-git)
 - Fetch the next task with `teachcode fetchtask`.
 
 ## Available Commands
 
-| command | description |
-| -------------- |  ---------------- |
-| teachcode init | Initializes all the tasks |
+| command                   | description                                                                           |
+| ------------------------- | ------------------------------------------------------------------------------------- |
+| teachcode init            | Initializes all the tasks                                                             |
 | teachcode fetchtask [key] | Fetches the task correponding to the key if provided (defaults to the very next task) |
-| teachcode submit | Submits the current task |
-| teachcode showkeys | Lists all the keys associated with the submitted tasks |
+| teachcode submit          | Submits the current task                                                              |
+| teachcode showkeys        | Lists all the keys associated with the submitted tasks                                |
 
 ## Contributing
 
@@ -63,6 +65,7 @@ Contributions of any kind are welcomed. Make sure that you go through these [gui
 This project uses [Commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) to check if the commit messages meet the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/).
 
 The full pattern is:
+
 ```sh
 type(scope?): subject #scope is optional
 
@@ -72,6 +75,7 @@ footer? #footer is optional
 ```
 
 Following that pattern, your commit messages should look like these:
+
 ```sh
 feat: activate open collective
 ```