Update Documentation in Conformance to the Documentation Guide

[vishnuravi]

Update Documentation in Conformance to the Documentation Guide

♻️ Current situation & Problem

See issue #24.

⚙️ Release Notes

• Updated documentation with setup instructions and examples.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

• I agree to follow the Code of Conduct and Contributing Guidelines.

[codecov]

Codecov Report

Merging #36 (6ba9a36) into main (63cb665) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   66.49%   66.49%           
=======================================
  Files          10       10           
  Lines         549      549           
=======================================
  Hits          365      365           
  Misses        184      184           

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 63cb665...6ba9a36. Read the comment docs.

[PSchmiedmayer]

Thank you for starring with improving the documentation here @vishnuravi; this is greatly appreciated 🚀

[PSchmiedmayer]

Thank you for the improvements @vishnuravi!

I fixed some configuration issues with the swift package index that I wanted to fix at some point anyways and also renamed a few of the image files to follow the ~dark prefix instead of -dark and to ensure that the dark and light mode images are named the same.

Feel free to merge the PR, it would be great to see if we can ensure that the images in the main README table are the same size as noted in the comment 👍

[PSchmiedmayer]

Very nice, this looks really good and thank you for fixing the scaling issue here 🚀