docs: Add link to website and update Docker run command

Problem: The README file lacked a link to the project's website, and did not explain how to use the images published on Docker Hub. Solution: Added a link to the website at the top of the README file, and added a Docker run command which uses the latest image from Docker Hub.
renfis · Apr 29, 2023 · cb566a3 · cb566a3
1 parent 7e7adae
commit cb566a3
Showing 1 changed file with 17 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -12,30 +12,36 @@ fine for the target audience.
 
 ![Screenshot of the Website](screenshot.webp)
 
+Access the tool at [pairwise98.de](https://www.pairwise98.de).
+
 This is a private project and is not affiliated with Microsoft.
 It simply uses [Microsoft PICT](https://github.com/microsoft/pict),
 which was published under the
 [MIT License](https://github.com/microsoft/pict/blob/main/LICENSE.TXT)
 by Microsoft.
 
-# Quarkus
+## Run latest version
 
-This project uses Quarkus, the Supersonic Subatomic Java Framework.
-To learn more about Quarkus, please visit its website at https://quarkus.io/.
+This project's Docker images are published on [Docker Hub](https://hub.docker.com/r/renfis/pict).
+The easiest way to run this project locally is to use the following command:
+
+```shell
+docker run --rm -it -p8080:8080 renfis/pict
+```
+
+Then navigate to <http://localhost:8080> in your favorite desktop browser.
 
 ## Build Docker image
 
-A Docker image is pushed to Docker Hub with each CI build and can be found
-here: https://hub.docker.com/r/renfis/pict. To build and run the Docker
-image locally, execute the following commands:
+To build and run the Docker image locally, execute the following commands:
 
 ```shell
 docker build -t pict .
 
 docker run --rm -it -p8080:8080 pict
 ```
 
-Then navigate to `http://localhost:8080` in your favorite desktop browser.
+Then navigate to <http://localhost:8080> in your favorite desktop browser.
 
 ## Running the application in dev mode
 
@@ -92,6 +98,10 @@ The SBOM files are also in the Docker image at the root directory as `bom.json`
 
 For more information about SBOMs and how to use them, please see the [CycloneDX documentation](https://cyclonedx.org/docs/).
 
+# Quarkus
+
+This project uses Quarkus, the Supersonic Subatomic Java Framework.
+To learn more about Quarkus, please visit its website at https://quarkus.io/.
 
 ## Related Guides