open-horizon-services / web-helloworld-cpp

Hello World Open Horizon service container implemented in C++
Apache License 2.0
1 stars 4 forks source link

Add README file #12

Open joewxboy opened 1 year ago

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:

JMAR059 commented 1 year ago

Hey @joewxboy can I be assigned to the issue?

joewxboy commented 1 year ago

@JMAR059 It has been assigned to you. Let me or @t-fine know if you have any questions.

JMAR059 commented 1 year ago

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:

Please let me know @joewxboy and @t-fine what you think to see if I can make a PR.

joewxboy commented 1 year ago

Please let me know @joewxboy and @t-fine what you think to see if I can make a PR.

Looks good, @JMAR059 just replace John Walicki with yourself as the author. :)

JMAR059 commented 1 year ago

Thanks! Just submitted the PR.