Merge "Add blurb on configuration and run_mirror in README"

2014-03-25 20:03:20 +00:00 · 2014-03-25 20:03:20 +00:00 · a4ade4b168
commit a4ade4b168
parent 63dfccb6cf 6e1f008c41
1 changed files with 29 additions and 0 deletions
--- 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
+