Add README file
Opened this issue · 5 comments
joewxboy commented
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 commented
JMAR059 commented
Just updated the README.md file in a forked repo: https://github.com/JMAR059/web-helloworld-cpp/tree/issue-12
I mainly used these example repos as examples to make it:
- https://github.com/open-horizon-services/service-node-red-hello-world
- https://github.com/open-horizon-services/web-helloworld-python
Please let me know @joewxboy and @t-fine what you think to see if I can make a PR.
joewxboy commented
JMAR059 commented
Thanks! Just submitted the PR.