From 16d3d4f74165a3099a7a5f1086448c3e1fff59e815d6bb8f4a5d9d4f322bc6aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dan=20=C4=8Cerm=C3=A1k?= <dcermak@suse.com>
Date: Wed, 22 May 2024 13:59:19 +0000
Subject: [PATCH] [info=fe77867d2c59dd7538017b6bd9ed987a]

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

diff --git a/README.md b/README.md
index 24254c2..b239fa3 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,87 @@
-# The openSUSE Tumbleweed BCI PHP 8 Container Image
+# The PHP 8 Container Image
+
 ![Redistributable](https://img.shields.io/badge/Redistributable-Yes-green)
 
 
-PHP 8 container based on the openSUSE Tumbleweed Base Container Image.
+PHP is a general-purpose scripting language used primarily for server-side web
+development. It can be used directly, embedded in HTML files, or executed via a
+server-side Apache2 module or CGI scripts.
+
+## How to use the image
+
+This image ships with the PHP interpreter as the entrypoint. The image is
+intended to be used to execute PHP scripts or PHP commands directly.
+
+To launch an interactive shell in a container, use the following command:
+```ShellSession
+$ podman run --rm -it registry.opensuse.org/opensuse/bci/php:8
+Interactive mode enabled
+
+php > echo 5+8;
+13
+```
+
+You can also use the container instead of the PHP
+interpreter to execute PHP scripts:
+```ShellSession
+$ cat /tmp/test.php
+<?php
+echo 5+8
+$ podman run --rm -it -v /tmp/test.php:/src/test.php:Z \
+    registry.opensuse.org/opensuse/bci/php:8 -f /src/test.php
+13
+```
+
+## How to install PHP extensions
+
+PHP extensions must be installed using the `zypper` package manager. PHP
+extensions are named using the `php8-$extension_name` scheme,
+and they can be installed as follows:
+
+```Dockerfile
+FROM registry.opensuse.org/opensuse/bci/php:8
+
+RUN zypper -n in php8-gd php8-intl
+```
+
+Alternatively, you can use the `docker-php-ext-install` script. It is provided
+for compatibility with the [PHP DockerHub Image](https://hub.docker.com/_/php)
+but it uses zypper to install the extensions from RPMs. It is provided for
+compatibility reasons and can be used similar to the script from PHP DockerHub
+image:
+
+```Dockerfile
+FROM registry.opensuse.org/opensuse/bci/php:8
+
+RUN docker-php-ext-install gd intl
+```
+
+## How to install PECL extensions
+
+[PECL](https://pecl.php.net/) is a package repository hosting PHP extensions. It
+can be used as an alternative source to obtain PHP extensions, but without any
+guarantee of interoperability with this image and without any official support.
+
+PECL extensions can be installed as follows:
+
+```Dockerfile
+FROM registry.opensuse.org/opensuse/bci/php:8
+
+RUN set -euo pipefail; \
+    zypper -n in $PHPIZE_DEPS php8-pecl; \
+    pecl install APCu-5.1.21;
+```
+
+**Note:** Building an extension may require installing additional dependencies.
+
+
+## Compatibility with the DockerHub Image
+
+The following scripts ship with the image to keep it compatible with the
+DockerHub image: `docker-php-source`, `docker-php-ext-configure`,
+`docker-php-ext-enable`, and `docker-php-ext-install`. Note that only
+`docker-php-ext-install` performs an actual job. None of the other scripts
+require to be executed in the image.
 
 ## Licensing
 `SPDX-License-Identifier: MIT`
diff --git a/php8-image.changes b/php8-image.changes
index b194cbb..b7691e7 100644
--- a/php8-image.changes
+++ b/php8-image.changes
@@ -1,3 +1,8 @@
+-------------------------------------------------------------------
+Wed May 22 13:38:53 UTC 2024 - Dan Čermák <dcermak@suse.com>
+
+- Extend README
+
 -------------------------------------------------------------------
 Sun May 19 09:10:06 UTC 2024 - Dan Čermák <dcermak@suse.com>