chore: README updated

[CodeWithEmad]

This will fix some issues in the readme:

• code blocks added.
• heading issues fixed.
• small typos fixed.

Also in the readme said:

lease tag @edx/engage-squad on any PRs or issues.

I wanted to tag @edx/engage-squad but looks like this account is deleted. should I update that too?

[openedx-webhooks]

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.83%. Comparing base (e3ecee1) to head (b01a129). Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1396      +/-   ##
==========================================
+ Coverage   88.76%   88.83%   +0.07%     
==========================================
  Files         305      307       +2     
  Lines        5234     5268      +34     
  Branches     1327     1304      -23     
==========================================
+ Hits         4646     4680      +34     
  Misses        572      572              
  Partials       16       16              

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[itsjeyd]

@CodeWithEmad Thank you for this contribution! We've got a green build so I'm marking it as ready for review now, but let me know if you had plans to work on it some more.

[itsjeyd]

Hey @openedx/2u-aurora team, this PR is ready for review.

[CodeWithEmad]

If @openedx/2u-aurora team maintains this repo, let me update the @edx/engage-squad mentioned in the readme.

[itsjeyd]

@CodeWithEmad Sounds good!

BTW, if a repo is maintained, it'll have the maintainer(s) listed as owner in its catalog-info.yaml file (example). So if you're ever unsure about the maintenance status of a repo you can just check that file.

[CodeWithEmad]

Got it.

[itsjeyd]

Hi @openedx/2u-aurora team, could you have a look at this PR please?

[itsjeyd]

Reached out to core contributors via Slack.

[openedx-webhooks]

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.