feat: README updates #29
Conversation
Signed-off-by: Sze Yan <89469273+szeyan543@users.noreply.github.com>
Signed-off-by: Sze Yan <89469273+szeyan543@users.noreply.github.com>
|
@szeyan543 is this PR ready for review? I'll give it a final review and merge today, but for any other PRs you might have planned or in progress, could you do a few things to help Joe and I (or anything looking back to these?
Then I think this PR will be perfect! I created an issue to document these things when it comes to contributing guidelines. I've gone ahead and done the three on this PR |
|
@t-fine Yes, this is ready for review. I'll make sure to provide all the things you listed next time. Thanks for the guidelines! |
Makefile
Outdated
| @@ -1,6 +1,6 @@ | |||
| # Extremely simple HTTP server that responds on port 8000 with a hello message. | |||
|
|
|||
| DOCKER_HUB_ID ?= ibmosquito | |||
| DOCKER_HUB_ID ?= szeyan11 | |||
There was a problem hiding this comment.
@szeyan543 if this isn't necessary for a new version can we just revert it?
|
|
||
| Begin by editing the variables at the top of the Makefile as desired. If you plan to push it to a Docker registery, make sure you give your docker ID. You may also want to create unique names for your **service** and **pattern** (necessary if you are sharing a tenancy with other users and you are all publishing this service). |
There was a problem hiding this comment.
Can you add something about the env var DOCKER_HUB_ID back in?
| ``` | ||
|
|
||
| 2. **Edit Makefile:** | ||
| Adjust the variables at the top of the Makefile as needed, including your Docker ID and unique names for your service and pattern. |
There was a problem hiding this comment.
I see you have a mention here, but maybe you could add a little block showing the values with their defaults and if they export them in their terminal they don't have to literally edit the values in the Makefile to override them
Signed-off-by: Sze Yan <89469273+szeyan543@users.noreply.github.com>
Signed-off-by: Sze Yan <89469273+szeyan543@users.noreply.github.com>
Signed-off-by: Sze Yan <89469273+szeyan543@users.noreply.github.com>
|
@t-fine I just modified the files according to your comments, can you check if it is okay? |
This pull request enhances the README file by restructuring its content and adding comprehensive information to make it more informative and user-friendly