docs: update readme to include CLI

[martincarapia]

Description

Update README.md to include CLI.

Related Issue

Fixes #29

Type of Change

Please mark the appropriate option below to describe the type of change your pull request introduces:

• Documentation update

Checklist

• My pull request has a clear title and description.
• I have used semantic commit messages.
  Examples: "fix: Fixed foobar bug", "feat(accounts): Added foobar feature".
• I have added/updated the necessary documentation on README.md.
• I have added appropriate test cases (if applicable) to ensure the changes are functioning correctly.

By submitting this pull request, I confirm that I have read and complied with the contribution guidelines of this project.

[aj3sh]

@martincarapia, I have added a few suggestions. Also, please include the text Closes issue #29 in the commit body instead of the commit header.

[aj3sh]

Sorry, I forgot to mention that we need to install the commitlint before using it.

pip install commitlint

[aj3sh]

Your commit still contains the Closes issue #29 text in the header. Please edit your commit message.

[martincarapia]

Alright fixed. Everything should be good.

[aj3sh]

Alright fixed. Everything should be good.

Now your PR has 7 commits. This can be fixed if you rebase your branch from the main branch.

[martincarapia]

Rebased.

[aj3sh]

@martincarapia, You somehow accidentally added some unnecessary commits to your branch. Consequently, your PR has four commits and two of them already exist in the main branch. I have added an image for the clarification.

However, this can be fixed using an interactive rebase. Make sure your branch updates with the main branch.

git fetch origin main
git rebase origin/main

Once the rebase is complete, you can use the interactive rebase.

git rebase -i 8761e42

where 8761e42 is the last commit of the main branch.

Using interactive rebase, you can delete unnecessary commits, squash two commits, reword the commits, and more.

Moreover, your commit header cannot end with period (.), and the best practice is to keep one commit for one PR.

Reference:
https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
https://medium.com/swlh/tutorial-on-interactive-rebasing-e3f49505b2ce

[martincarapia]

Thank you for your clarification, and thank you for your patience. I'm new to all of this.

[aj3sh]

Looks good.