summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2016-11-04 14:27:00 +0100
committerRodolfo Carvalho <rhcarvalho@gmail.com>2016-11-08 14:19:14 +0100
commit410edffcf21560e30c4ecb3ffcd01fef704de791 (patch)
tree76374156b62fb171e1819e59661a77bdbebd1e2f /README.md
parent9ba3bea14236147e094d7ba192d09b4a498689b7 (diff)
downloadopenshift-410edffcf21560e30c4ecb3ffcd01fef704de791.tar.gz
openshift-410edffcf21560e30c4ecb3ffcd01fef704de791.tar.bz2
openshift-410edffcf21560e30c4ecb3ffcd01fef704de791.tar.xz
openshift-410edffcf21560e30c4ecb3ffcd01fef704de791.zip
README: improve first paragraph
- Explain this repository can be used to install, upgrade and manage OpenShift clusters. - Move note about docker RPM to its own paragraph; link to issue.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 21798aa78..13587f712 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,14 @@
# OpenShift Ansible
-This repo contains [Ansible](https://www.ansible.com/) code for
-[OpenShift](https://www.openshift.com/). This repo and the origin RPMs that it
-installs currently require a package that provides `docker`. Currently the RPMs
-provided from dockerproject.org do not provide this requirement, though they may
-in the future.
+This repository contains [Ansible](https://www.ansible.com/) code to install,
+upgrade and manage [OpenShift](https://www.openshift.com/) clusters.
+
+**Note**: the Ansible playbooks in this repository require an RPM package that
+provides `docker`. Currently, the RPMs from
+[dockerproject.org](https://dockerproject.org/) do not provide this requirement,
+though they may in the future. This limitation is being tracked by
+[#2720](https://github.com/openshift/openshift-ansible/issues/2720).
## Branches and tags