Update: some wording.

[github/fretlink/docker-ansible.git] / README.md

diff --git a/README.md b/README.md
index a9761eb83f6eb4a2dc0559f6b1a79d0153ebf50d..98db6eaf84eeb159e9371e8b39139d6fce452c14 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 Docker-Ansible base images
 ===================
 
-[![Build Status](https://travis-ci.org/William-Yeh/docker-ansible.svg?branch=master)](https://travis-ci.org/William-Yeh/docker-ansible)
+[![Circle CI](https://circleci.com/gh/William-Yeh/docker-ansible.svg?style=shield)](https://circleci.com/gh/William-Yeh/docker-ansible) [![Build Status](https://travis-ci.org/William-Yeh/docker-ansible.svg?branch=master)](https://travis-ci.org/William-Yeh/docker-ansible)
 
 
 ## Summary
@@ -18,12 +18,12 @@ These are Docker images for [Ansible](https://github.com/ansible/ansible) softwa
 
 - OS: Debian (jessie, wheezy), Ubuntu (trusty, precise), CentOS (7, 6)
 
-- Ansible: usually the latest version.
+- Ansible: usually the latest version (I didn't pin any specific version).
 
 
 ## Images and tags
 
-- normal series:
+- Normal series:
 
   - `williamyeh/ansible:debian8`
   - `williamyeh/ansible:debian7`
@@ -32,7 +32,7 @@ These are Docker images for [Ansible](https://github.com/ansible/ansible) softwa
   - `williamyeh/ansible:centos7`
   - `williamyeh/ansible:centos6`
 
-- onbuild series:
+- Onbuild series:
 
   - `williamyeh/ansible:debian8-onbuild`
   - `williamyeh/ansible:debian7-onbuild`
@@ -53,11 +53,14 @@ Second, put the following `Dockerfile` along with your playbook directory:
 ```
 FROM williamyeh/ansible:ubuntu14.04-onbuild
 
-# ==> Specify playbook filename;   default = "playbook.yml"
-#ENV PLAYBOOK   playbook.yml
+# ==> Specify requirements filename;  default = "requirements.yml"
+#ENV REQUIREMENTS  requirements.yml
 
-# ==> Specify inventory filename;  default = "/etc/ansible/hosts"
-#ENV INVENTORY  inventory.ini
+# ==> Specify playbook filename;      default = "playbook.yml"
+#ENV PLAYBOOK      playbook.yml
+
+# ==> Specify inventory filename;     default = "/etc/ansible/hosts"
+#ENV INVENTORY     inventory.ini
 
 # ==> Executing Ansible...
 RUN ansible-playbook-wrapper
@@ -67,7 +70,7 @@ Third, `docker build .`
 
 Done!
 
-For more advanced usage, the role in Ansible Galaxy [`williamyeh/nginx`](https://galaxy.ansible.com/list#/roles/2245) also demonstrates how to do a simple integration test for a variety of Linux distributions on [Travis CI](https://travis-ci.org/)’s Ubuntu 12.04 worker instances.
+For more advanced usage, the role in Ansible Galaxy [`williamyeh/nginx`](https://galaxy.ansible.com/list#/roles/2245) demonstrates how to perform a simple smoke test (*configuration needs test, too!*) on a variety of (*containerized*) Linux distributions via [CircleCI](https://circleci.com/)'s Ubuntu 12.04 and [Travis CI](https://travis-ci.org/)’s Ubuntu 14.04 worker instances.
 
 
 
@@ -84,6 +87,7 @@ In the beginning I used the [`ansible/ansible-docker-base`](https://github.com/a
 
 Therefore, I built these Docker images on my own.
 
+**NOTE:** [`ansible/ansible-docker-base`](https://github.com/ansible/ansible-docker-base) announced in September 2015: “Ansible no longer maintains images in Dockerhub directly.”
 
 ### Comparison: image size
 
@@ -104,7 +108,7 @@ williamyeh/ansible            ubuntu14.04-onbuild   238.3 MB
 
 ## Usage
 
-Used mostly as a *base image* for configuring, with Ansible, other software stack on some specified Linux distribution.
+Used mostly as a *base image* for configuring other software stack on some specified Linux distribution(s).
 
 Take Debian/Ubuntu/CentOS for example. To test an Ansible `playbook.yml` against a variety of Linux distributions, we may use [Vagrant](https://www.vagrantup.com/) as follows:
 
@@ -173,11 +177,14 @@ FROM williamyeh/ansible:ubuntu14.04-onbuild
 #FROM williamyeh/ansible:centos6-onbuild
 
 
-# ==> Specify playbook filename;   default = "playbook.yml"
-#ENV PLAYBOOK   playbook.yml
+# ==> Specify requirements filename;  default = "requirements.yml"
+#ENV REQUIREMENTS  requirements.yml
+
+# ==> Specify playbook filename;      default = "playbook.yml"
+#ENV PLAYBOOK      playbook.yml
 
-# ==> Specify inventory filename;  default = "/etc/ansible/hosts"
-#ENV INVENTORY  inventory.ini
+# ==> Specify inventory filename;     default = "/etc/ansible/hosts"
+#ENV INVENTORY     inventory.ini
 
 # ==> Executing Ansible...
 RUN ansible-playbook-wrapper