update readme

[sympatheticmoose]

This PR makes a number of changes to the readme:

• General rewordings and expanding on details
• Adds CI and Go Report Shields
• Removes arguably unnecessary content in the npx/local examples and strips some content from example output
• Replaces the Analyzers section with a new table format to save space and specifies the function names for each analyzer
• Removes reference for feature requests on additional git providers
• Updates npx command to add @latest to ensure users always run latest version and dont hit potential issues due to cached versions
• Adds new getting help section which has a generic "raise feature request" call to action
• Adds new Analyzers to the table and attempts to explain them. Some (listed below) seemingly don't appear even in tool output even when reportAll: true is configured, so may need removing? Perhaps they can't be configured individually through a config file?
  • gomanifest
  • jssourcemap
  • pluginname
  • logos
  • sourcecode
  • published (guessing just used in version?)
  • unsafesvg
• It advises that private repositories are not supported (assumption)

Potential follow ups and questions not addressed through this PR:

• Are local git repositories (not just zips) supported for -sourceCodeUri?
• Are non-git locations supported for remote zip files i.e. FTP servers?
• Can we share or reference the Grafana Labs configuration required for publishing to the catalog (is this the default behaviour)?
• Can the naming convention be shared?
• Add (at least) code of conduct and contributing guidelines
• The local steps will only work if the user has set up their $PATH appropriately, maybe worth advising, might be too much detail?

[CLAassistant]

All committers have signed the CLA.

[tolzhabayev]

🚀

[briangann]

excellent update!

[briangann]

minor edit (an is correct before URL)

an URL to a git repository, or a local file (starting with file://)

[sympatheticmoose]

I always debate this 😄 Google suggests a URL (which does read more naturally imo) - source1 source2