From 8c34608b256622c347d7bfdc566323a1c9316ada322979cc1932653895d64470 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dan=20=C4=8Cerm=C3=A1k?= <dcermak@suse.com>
Date: Wed, 29 May 2024 08:33:27 +0000
Subject: [PATCH] [info=d21f12f1d956a166d492bd0a47095ee5]

OBS-URL: https://build.opensuse.org/package/show/devel:BCI:Tumbleweed/golang-oldstable-image?expand=0&rev=91
---
 README.md                      | 71 +++++++++++++++++++++++++++++++++-
 golang-oldstable-image.changes |  5 +++
 2 files changed, 74 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 69b3952..862d9e8 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,75 @@
-# The openSUSE Tumbleweed BCI Go 1.21 development Container Image
+# Go 1.21 development Container Image
+
 ![Redistributable](https://img.shields.io/badge/Redistributable-Yes-green)
 
 
-Go 1.21 development container based on the openSUSE Tumbleweed Base Container Image.
+## Description
+
+[Go](https://go.dev/) (a.k.a., Golang) is a statically-typed programming language, with syntax loosely derived from C. Go offers additional features such as garbage collection, type safety, certain dynamic-typing capabilities, additional built-in types (for example, variable-length arrays and key-value maps) as well as a large standard library.
+
+## Usage
+
+To compile and deploy an application, copy the sources, fetch dependencies (assuming go.mod is used for dependency management), and build the binary:
+
+```Dockerfile
+# Build the application using the Go 1.21 development Container Image
+FROM registry.opensuse.org/opensuse/bci/golang:1.21 as build
+
+WORKDIR /app
+
+# pre-copy/cache go.mod for pre-downloading dependencies and only redownloading them in subsequent builds if they change
+COPY go.mod go.sum ./
+RUN go mod download && go mod verify
+
+COPY . ./
+
+# Make sure to build the application with CGO disabled.
+# This will force Go to use some Go implementations of code
+# rather than those normally supplied by the host operating system.
+# You need this for scratch images as those supporting libraries
+# are not available.
+RUN CGO_ENABLED=0 go build -o /hello
+
+# Bundle the application into a scratch image
+FROM scratch
+
+COPY --from=build /hello /hello
+
+CMD ["/hello"]
+```
+
+Build and run the container image:
+
+```ShellSession
+$ podman build -t my-golang-app .
+$ podman run -it --rm my-golang-app
+```
+
+There are situations when you don't want to run an application inside a container.
+
+To compile the application, without running it inside a container instance, use the following command:
+
+```ShellSession
+$ podman run --rm -v "$PWD":/app:Z -w /app registry.opensuse.org/opensuse/bci/golang:1.21 go build -v
+```
+
+To run the application tests inside a container, use the following command:
+
+```ShellSession
+$ podman run --rm -v "$PWD":/app:Z -w /app registry.opensuse.org/opensuse/bci/golang:1.21 go test -v
+```
+
+**Note:** The Golang image should be used as a build environment. For runtime, self-contained Go binaries should use a `scratch` image and for applications that require external dependencies use the `bci-base` image.
+
+## Additional tools
+
+The following additional tools are included in the image:
+
+- go1.21-race
+- make
+- git-core
+
+
 
 ## Licensing
 `SPDX-License-Identifier: MIT`
diff --git a/golang-oldstable-image.changes b/golang-oldstable-image.changes
index fbababa..2c0dd3c 100644
--- a/golang-oldstable-image.changes
+++ b/golang-oldstable-image.changes
@@ -1,3 +1,8 @@
+-------------------------------------------------------------------
+Tue May 28 12:13:17 UTC 2024 - Alexandre Vicenzi <alexandre.vicenzi@suse.com>
+
+- Extend README.md
+
 -------------------------------------------------------------------
 Tue May  7 19:07:24 UTC 2024 - Dirk Mueller <dmueller@suse.com>