Update README

Author: jhj0517

README.md

@@ -1,5 +1,5 @@
 # Python Project Template
-This is basic python project template with basic CI/CD GA workflow & GH issue & PR template. Anyone can use this template to start a new python project.
+This is a Python project template that anyone can use with basic CI/CD pipeline, issue and PR templates etc.
 
 ## Directory Structure
 You can remove the `(optional)` directories if you don't need them. (e.g. `docker/`, `setup.py`, etc.)
@@ -10,54 +10,61 @@ python-project-template/
 ├── tests/                  # Test codes with pytest
 ├── .gitignore              # gitignore file 
 ├── README.md               # README file
+├── pyproject.toml          # (optional) PyPI package configuration file
+├── setup.py                # (optional) PyPI package setup file
 └── requirements.txt        # Project dependencies 
 ```
 
 ## Github Actions
-1. [`ci.yml`](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/ci.yml)
-Basic CI workflow with pytest. It runs tests in the [`tests`](https://github.com/jhj0517/python-project-template/tree/master/tests) directory, with master branch commit & PR triggers by default.
-2. [`publish-dockerhub.yml`](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml)
-Basic CD workflow for DockerHub. This workflow is optional, only needed when you want to publish the docker image to the dockerhub. You can remove this workflow if you don't need it.<br>
-It will build the docker image with [`docker/Dockerfile`](https://github.com/jhj0517/python-project-template/tree/master/docker/Dockerfile) and [`docker/docker-compose.yaml`](https://github.com/jhj0517/python-project-template/tree/master/docker/docker-compose.yaml) for the project and publish it to the dockerhub with the tag `latest`.<br>
-The auto-trigger for this workflow is disabled by default. You can edit the workflow to enable it.<br>
-Before using the workflow, you need to set the `DOCKERHUB_USERNAME` & `DOCKERHUB_TOKEN` in the repository secrets.
+1. [ci.yml](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/ci.yml)
 
-[image](URL)
+Basic CI workflow with pytest. It runs tests in the [tests/](https://github.com/jhj0517/python-project-template/tree/master/tests) directory, with master branch commit & PR triggers by default.
+
+2. [publish-dockerhub.yml](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml)
+
+Basic CD workflow for DockerHub publishing. You can remove this workflow if you don't need it.<br>
+It will build the docker image with files in the [docker/](https://github.com/jhj0517/python-project-template/tree/master/docker) and publish it to the dockerhub. The auto-trigger of the action is disabled by default.<br>
+Before using the workflow, you need to set the `DOCKERHUB_USERNAME` & `DOCKERHUB_TOKEN` in the repository settings.
+
+![image](https://github.com/user-attachments/assets/ab9f7081-fa07-4181-af30-b6646161bc0b)
 
 And make sure to edit the `image-name` in the workflow.
 
-[code-url](URL)
+https://github.com/jhj0517/python-project-template/blob/0c9dc95cece122815f1096607b952b1a033e2e7d/.github/workflows/publish-dockerhub.yml#L43-L44
+
+
+3. [publish-pypi.yml](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml)
+   
+Basic CD workflow for pypi package. You can remove this workflow if you don't need it. <br>
+The auto-trigger for this workflow is disabled by default. If enabled, it will build and publish to pypi whenever you make a new "release" in the repository.  
 
-3. [`publish-pypi.yml`](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml)
-Basic CD workflow for pypi package. This is the workflow that only used in case when your project is a python package that will be published in the pypi. You can remove this workflow if you don't need it.<br>
-It will build it and publish it to pypi whenever you make a new "release" in the repository.<br>
-The auto-trigger for this workflow is disabled by default. You can edit the workflow to enable it.<br>
 Before using the workflow, edit package name to yours in the workflow.
 
-[code-url](URL)
+https://github.com/jhj0517/python-project-template/blob/0c9dc95cece122815f1096607b952b1a033e2e7d/.github/workflows/publish-pypi.yml#L18-L19
 
 ## Issue & PR Template
 There are some basic templates for the issue & PR. You can edit them or add more to fit your project's needs.
 
 - Issue Templates:
-  1. [`bug_report.md`](https://github.com/jhj0517/python-project-template/tree/master/.github/ISSUE_TEMPLATE/bug_report.md) : Basic bug report template
-  2. [`feature_request.md`](https://github.com/jhj0517/python-project-template/tree/master/.github/ISSUE_TEMPLATE/feature_request.md) : Feature request template
+  1. [bug_report.md](https://github.com/jhj0517/python-project-template/tree/master/.github/ISSUE_TEMPLATE/bug_report.md) : Basic bug report template
+  2. [feature_request.md](https://github.com/jhj0517/python-project-template/tree/master/.github/ISSUE_TEMPLATE/feature_request.md) : Feature request template
 
-- PR Template: [`pull_request_template.md`](https://github.com/jhj0517/python-project-template/tree/master/.github/pull_request_template.md)
+- PR Template: [pull_request_template.md](https://github.com/jhj0517/python-project-template/tree/master/.github/pull_request_template.md)
 
 
 ## Docker
 
-The [`docker/`](https://github.com/jhj0517/python-project-template/tree/master/docker) directory and [`publish-dockerhub.yml`](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml) are associated with building the docker image and publishing to dockerhub. You can remove them if you don't need them.<br>
-Before building image, make sure to edit the variable in the [`docker/Dockerfile`](https://github.com/jhj0517/python-project-template/tree/master/docker/Dockerfile):
+The [docker/](https://github.com/jhj0517/python-project-template/tree/master/docker) directory and [publish-dockerhub.yml](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml) are associated with the Docker CI/CD pipeline. You can remove them if you don't need them.
+
+Before building image, make sure to edit the variable in the [docker/Dockerfile](https://github.com/jhj0517/python-project-template/tree/master/docker/Dockerfile):
 
-[code-url](URL)
+https://github.com/jhj0517/python-project-template/blob/0c9dc95cece122815f1096607b952b1a033e2e7d/docker/Dockerfile#L3-L4
 
-And in [`docker/docker-compose.yaml`](https://github.com/jhj0517/python-project-template/tree/master/docker/docker-compose.yaml) as well:
+And edit [docker/docker-compose.yaml](https://github.com/jhj0517/python-project-template/tree/master/docker/docker-compose.yaml) as well:
 
-[code-url](URL)
+https://github.com/jhj0517/python-project-template/blob/0c9dc95cece122815f1096607b952b1a033e2e7d/docker/docker-compose.yaml#L6-L7
 
-The image is built and published automatically by the action, but you can also manually build and run the image with the following commands.
+The image is built and published automatically by the CI/CD pipeline, but you can also manually build and run the image with the following commands.
 
 1. git clone this repository
 ```bash
@@ -73,14 +80,12 @@ docker compose -f docker/docker-compose.yaml up
 ```
 
 ## PyPI
-The [`setup.py`](https://github.com/jhj0517/python-project-template/tree/master/setup.py), [`pyproject.toml`](https://github.com/jhj0517/python-project-template/tree/master/setup.py) and [`publish-pypi.yml`](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml) are associated with building the package and publishing to PyPI. You can remove them if you don't need them.<br>
-Make sure to edit dependencies & variables in the [`pyproject.toml`](https://github.com/jhj0517/python-project-template/tree/master/setup.py) as your project's needs.
+The [setup.py](https://github.com/jhj0517/python-project-template/tree/master/setup.py), [pyproject.toml](https://github.com/jhj0517/python-project-template/tree/master/pyproject.toml) and [publish-pypi.yml](https://github.com/jhj0517/python-project-template/tree/master/.github/workflows/publish-dockerhub.yml) are associated with the PyPI package CI/CD pipeline. You can remove them if you don't need them.
 
+Make sure to edit dependencies & variables in the [pyproject.toml](https://github.com/jhj0517/python-project-template/tree/master/pyproject.toml) as your project's needs.
 
 ## How to start 
-Click "Use this template" and "Create a new repository". Then git clone it and you can start your own project. 
-
-[image-url](URL)
-
+Click "Use this template" and "Create a new repository". Then you can start your own project with `git clone`. 
 
+![image](https://github.com/user-attachments/assets/b628232a-09b1-4f49-9751-5ec4723d60ab)