Skip to content

[Feature]: README Updates #37

@Malcolmnixon

Description

@Malcolmnixon

Problem Statement

The README.md file needs to be updated.

Proposed Solution

Update the README.md file with:

  • Badges for forks, stars, contributors, license, build, sonarqube-quality-gate (link to sonarqube project), sonarqube-security (link to sonarqube project), and nuget (link to nuget project).
  • Features table with icons
  • Installation Instructions
  • Contributing (link to Contributing)
  • License (with link to License)
  • Support (links to report bugs, request features, and ask questions)
  • Acknowledgements

Alternatives Considered

No response

Additional Context

No response

Priority

Medium - Would improve workflow

Contribution

  • I would be willing to submit a PR for this feature

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions