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 +