From 3ea1d67186e27f7637d65faaeee6b517a0adc4af Mon Sep 17 00:00:00 2001
From: Gong Sophia <sophia.gong@intel.com>
Date: Fri, 30 Aug 2019 13:57:49 +0800
Subject: [PATCH] update os-core/README.md

Signed-off-by: Gong Sophia <sophia.gong@intel.com>
---
 os-core/README.md | 98 ++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 79 insertions(+), 19 deletions(-)

diff --git a/os-core/README.md b/os-core/README.md
index 6a7a423..5ae2e68 100644
--- a/os-core/README.md
+++ b/os-core/README.md
@@ -1,23 +1,83 @@
-os-core
-==========
-This provides the common base layer shared by all Clear Linux* based containers.  It
-is not designed to be used stand alone, but to be pulled in via a FROM entry in a new
-Dockerfile.
+# Clear Linux* OS `os-core` container image
 
-Build
------
-```
-docker build -t clearlinux/os-core .
-```
+<!-- Required -->
+## What is this image?
 
-Or just pull it from Dockerhub
----------------------------
-```
-docker pull clearlinux/os-core
-```
+`clearlinux/os-core` is a Docker image with `os-core` running on top of the
+[official clearlinux base image](https://hub.docker.com/_/clearlinux). 
 
-Extra Build ARGs
-----------------
-- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags
+<!-- application introduction -->
+> This os-core container provides the common base layer shared by all Clear Linux* based 
+> containers. It is not designed to be used stand alone, but to be pulled in via a FROM 
+> entry in a new Dockerfile.
 
-Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg
+For other Clear Linux* OS
+based container images, see: https://hub.docker.com/u/clearlinux
+
+## Why use a clearlinux based image?
+
+<!-- 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.
+
+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. 
+
+1. Pull the image from Docker Hub: 
+    ```
+    docker pull clearlinux/os-core
+    ```
+
+<!-- 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 os-core/
+    ```
+
+3. Build the container image:
+    ```
+    docker build -t clearlinux/os-core .
+    ```
+
+   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