Create a good README.md file

[joewxboy]

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:

• https://github.com/open-horizon-services/service-node-red-hello-world/blob/main/README.md
• https://github.com/open-horizon-services/service-fledge/blob/main/README.md
• https://github.com/open-horizon-services/service-homeassistant/blob/main/README.md

[harry251]

Could you assign me this issue? @joewxboy @playground

[joewxboy]

@harry251 You got it! Let us know if you have any questions.

[harry251]

@playground @t-fine

Could you check my description in the README? Please tell me if there are errors.

Also I need help with writing sections like prerequisites and installation. Is there a website I can reference or could you give me a brief explanation?

I also noticed that there is no license. Is there any plan for license? Correct me if I am wrong.

[playground]

Hi @harry251, thanks for the nice work in the README. Can you add a few sentences to mention the integration of Open Horizon will enable LP with enriched features and perform certain tasks in real-time even when it is offline? For example, visual inspections, analytics, inferencing... with ML on the edge device itself.

[harry251]

Of course. @playground

Do other sections look okay to you? Also, I am a little lost how to write Installation. Are there any references?

[playground]

I think we can add to them as we go. Let me also add @Adamlip1334 and @IBMAngel, can you guys think of anything should be included in the README?