PE-436: each example should have its own README to explain and instruct usage

jdmedlin1 commented 1 month ago

📝 Description

This PR adds descriptive changes to existing readmes in effort to better inform and instruct users about the examples provided in this repository.

The two primary changes in this PR are 1) the node-simple-server-example readme to add build and run instructions, and 2) context of other examples in the root of the examples directory.

Issue: https://brightsign.atlassian.net/browse/PE-436

📋 List of Changes

Please provide a concise list of the main changes.

🧪 Steps to Test

Step 1

Notes to the Reviewer

📸 Screenshots

✔️ Dev Complete Checklist

[ ] PR template filled out
[ ] Change is tested by submitter
[ ] PR follows all linting and coding standards
[ ] Github Issue exists (if applicable)
[ ] Team member has been assigned
[ ] At least one commit message is in Conventional Commit format

mingjun7 commented 1 month ago

PR description needs some update?

mingjun7 commented 1 month ago

I'm a bit confused what this PR is intend to do. From the title it sounds like there are some repo does not have readme, and the task is to add the readme to some example folder. The changes are modifying the readme instead. Can you describe what are the points need update in the existing readme? Does any other file need to be updated?

Also, I think we should consolidate the file name readme.md v.s. README.md across the repo.

brightsign / dev-cookbook