search

open-horizon-services / service-edgex-foundry

0 stars 1 forks source link

Add shields to README #3

Open mahi-pas opened 1 year ago

mahi-pas commented 1 year ago

See https://github.com/open-horizon-services/service-homeassistant for an example of shields to add

johnwalicki commented 1 year ago

I also like the "Contributor" shield - example in https://github.com/open-horizon-services/service-node-red-hello-world

joewxboy commented 1 year ago

This README needs better information:

  1. Front matter
  2. Shields - license should match LICENSE file
  3. Description
  4. Prerequisites
  5. Installation
  6. Usage
  7. Advanced Details
  8. Authors - should match MAINTAINERS.md

See examples of good README.md files:

joewxboy commented 1 year ago

Note: The service needs to be added before this task can be worked on.