From c7dc34035b093915d7b77ca7ebd072dc26a0ace2 Mon Sep 17 00:00:00 2001
From: Gong Sophia <sophia.gong@intel.com>
Date: Fri, 30 Aug 2019 14:03:54 +0800
Subject: [PATCH] update php/README.md

Signed-off-by: Gong Sophia <sophia.gong@intel.com>
---
 php/README.md | 136 +++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 100 insertions(+), 36 deletions(-)

diff --git a/php/README.md b/php/README.md
index 4f4cac6..8985cf2 100644
--- a/php/README.md
+++ b/php/README.md
@@ -1,43 +1,107 @@
-php
-==========
-This provides a Clear Linux* php basic cli instance.
+# Clear Linux* OS `php` container image
 
-Build
------
-```
-docker build -t clearlinux/php .
-```
+<!-- Required -->
+## What is this image?
 
-Or just pull it from Dockerhub
----------------------------
-```
-docker pull clearlinux/php
-```
+`clearlinux/php` is a Docker image with `php` running on top of the
+[official clearlinux base image](https://hub.docker.com/_/clearlinux). 
 
-start a php instance
------------------------
-```
-docker run --name some-php clearlinux/php
-```
+<!-- application introduction -->
+> [PHP](https://www.php.net/) (Hypertext Preprocessor) is a general-purpose 
+> programming language originally designed for web development.the PHP reference 
+> implementation is now produced by The PHP Group.PHP originally stood for Personal 
+> Home Page, but it now stands for the recursive initialism PHP: Hypertext Preprocessor
 
-Run my own php instance
------------------------
-Create a Dockerfile in your own php project
-```
-FROM clearlinux/php:latest
-COPY . /usr/src/myphpapp
-WORKDIR /usr/src/myphpapp
-CMD [ "php", "./my-script.php" ]
-```
+For other Clear Linux* OS
+based container images, see: https://hub.docker.com/u/clearlinux
 
-Then, run the commands to build and run the Docker image:
-```
-$ docker build -t my-own-php-instance .
-$ docker run -it --rm --name my-running-php my-own-php-instance
-```
+## Why use a clearlinux based image?
 
-Extra Build ARGs
-----------------
-- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags
+<!-- CL introduction -->
+> [Clear Linux* OS](https://clearlinux.org/) is an open source, rolling release
+> Linux distribution optimized for performance and security, from the Cloud to
+> the Edge, designed for customization, and manageability.
 
-Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg
+Clear Linux* OS based container images use:
+* Optimized libraries that are compiled with latest compiler versions and
+  flags.
+* Software packages that follow upstream source closely and update frequently.
+* An aggressive security model and best practices for CVE patching.
+* A multi-staged build approach to keep a reduced container image size.
+* The same container syntax as the official images to make getting started
+  easy. 
+
+To learn more about Clear Linux* OS, visit: https://clearlinux.org.
+
+<!-- Required -->
+## Deployment:
+
+### Deploy with Docker
+The easiest way to get started with this image is by simply pulling it from
+Docker Hub. 
+
+*Note: This container uses the same syntax as the [official php
+image](https://hub.docker.com/_/php).
+
+
+1. Pull the image from Docker Hub: 
+    ```
+    docker pull clearlinux/php
+    ```
+
+2. Start a container using the examples below:
+  
+   Create a Dockerfile in your own php project
+  ```
+    FROM clearlinux/php:latest
+    COPY . /usr/src/myphpapp
+    WORKDIR /usr/src/myphpapp
+    CMD [ "php", "./my-script.php" ]
+    ```
+
+  Then, run the commands to build and run the Docker image:
+    ```
+    $ docker build -t my-own-php-instance .
+    $ docker run -it --rm --name my-running-php my-own-php-instance
+    ```
+
+<!-- Optional -->
+### Deploy with Kubernetes
+
+
+<!-- Required -->
+## Build and modify:
+
+The Dockerfiles for all Clear Linux* OS based container images are available at
+https://github.com/clearlinux/dockerfiles. These can be used to build and
+modify the container images.
+
+1. Clone the clearlinux/dockerfiles repository.
+    ```
+    git clone https://github.com/clearlinux/dockerfiles.git
+    ```
+
+2. Change to the directory of the application:
+    ```
+    cd php/
+    ```
+
+3. Build the container image:
+    ```
+    docker build -t clearlinux/php .
+    ```
+
+   Refer to the Docker documentation for [default build
+   arguments](https://docs.docker.com/engine/reference/builder/#arg).
+   Additionally:
+   
+   - `swupd_args` - specifies arguments to pass to the Clear Linux* OS software
+     manager. See the [swupd man
+     pages](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options)
+     for more information.
+
+<!-- Required -->
+## Licenses
+
+All licenses for the Clear Linux* Project and distributed software can be found
+at https://clearlinux.org/terms-and-policies