Update/doumentation

[Lunga-Ntando-Ndlovu]

Pull Request

Description:

Added links to README and merged

Related Issues:

[Reference any related issues or documents.]

Type of Change:

• Bug Fix
• New Feature
• Enhancement
• Refactoring
• Documentation Update

[codecov]

Codecov Report

Attention: Patch coverage is 62.33766% with 116 lines in your changes are missing coverage. Please review.

Please upload report for BASE (main@a5cf902). Learn more about missing BASE report.
Report is 2 commits behind head on main.

Files	Patch %	Lines
src/server/workspace/src/utils/utility.ts	12.00%	22 Missing ⚠️
...rver/workspace/src/auth/strategies/jwt.strategy.ts	0.00%	13 Missing and 1 partial ⚠️
src/server/workspace/src/auth/auth.module.ts	0.00%	12 Missing ⚠️
...er/workspace/src/auth/strategies/local.strategy.ts	0.00%	10 Missing and 1 partial ⚠️
src/server/workspace/src/auth/auth.service.ts	43.75%	9 Missing ⚠️
src/server/workspace/src/app.module.ts	0.00%	6 Missing ⚠️
.../workspace/src/organisation/organisation.module.ts	0.00%	6 Missing ⚠️
src/server/workspace/src/user/user.module.ts	0.00%	6 Missing ⚠️
src/server/workspace/src/user/user.service.ts	83.78%	6 Missing ⚠️
...server/workspace/src/workspace/workspace.module.ts	0.00%	6 Missing ⚠️
... and 7 more

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage        ?   60.75%           
=======================================
  Files           ?       29           
  Lines           ?      316           
  Branches        ?       14           
=======================================
  Hits            ?      192           
  Misses          ?      122           
  Partials        ?        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.