feat: add more information in readme

[dipinknair]

as title says

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -0.68% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (bc2e960)	3109	2545	81.86%
Head commit (c5e8073)	3109 (+0)	2524 (-21)	81.18% (-0.68%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#1501)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.18%. Comparing base (bc2e960) to head (c5e8073).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1501   +/-   ##
=======================================
  Coverage   81.18%   81.18%           
=======================================
  Files          42       42           
  Lines        3109     3109           
=======================================
  Hits         2524     2524           
  Misses        585      585           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

The documentation for this pull request will be available at https://mechanical.docs.pyansys.com/pull/1501. Please allow some time for the documentation to be deployed.