New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add shields to README #4

Open

mahi-pas opened this issue Oct 18, 2022 · 2 comments

Labels

documentation good first issue hacktoberfest

mahi-pas commented Oct 18, 2022

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

johnwalicki commented Oct 18, 2022

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

joewxboy added the hacktoberfest label

Member

joewxboy commented Feb 18, 2023

This README needs better information:

Front matter
Shields - license should match LICENSE file
Description
Prerequisites
Installation
Usage
Advanced Details
Authors - should match MAINTAINERS.md

See examples of good README.md files:

joewxboy added documentation good first issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment