From 6e1f008c4145b8bb4566b78947d94af73f863ae9 Mon Sep 17 00:00:00 2001
From: Gregory Haynes <greg@greghaynes.net>
Date: Sun, 16 Mar 2014 16:41:25 -0700
Subject: [PATCH] Add blurb on configuration and run_mirror in README

Currently the configuration syntax is only documented in the run_mirror
source. Adding enough information to the RAEDME for users to get up and
running with a simple configuration is much more user friendly.

Change-Id: I54d978ac127dfe37348167f3a2b08cc09119619b
---
 README.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.rst b/README.rst
index 14f9d2a..15d0b13 100644
--- a/README.rst
+++ b/README.rst
@@ -10,3 +10,32 @@ things you expect to download from PyPI.
 
 pypi-mirror will build a local static mirror for you based on requirements
 files in git repos.
+
+
+Configuration
+-------------
+
+A YAML configuration is needed to create a mirror. Below is an example
+configuration. ::
+
+  cache-root: /tmp/cache
+
+  mirrors:
+    - name: openstack
+      projects:
+        - https://git.openstack.org/openstack/requirements
+      output: /tmp/mirror/openstack
+
+    - name: openstack-infra
+      projects:
+        - https://git.openstack.org/openstack-infra/config
+      output: /tmp/mirror/openstack-infra
+
+
+Creating a mirror
+-----------------
+
+The run_mirror utility creates a mirror. ::
+
+  run-mirror -c mirror.yaml
+