diff --git a/README.rst b/README.rst index 669bd56..d198d7f 100644 --- a/README.rst +++ b/README.rst @@ -1,23 +1,31 @@ -apt-cacher-formula -================== +apt-cacher +========== -Install the apt-cacher. This allows you to install either the server or the -client version. +Formulas to install the apt-cacher package or to configure clients to +use a apt-cacher proxy. .. note:: + See the full `Salt Formulas installation and usage instructions `_. Requirements ------------ -apache-formula +`apache-formula `_ Available states ----------------- +================ + +.. contents:: + :local: ``apt-cacher.server`` - Installs the server +-------------------- + + Installs the apt-cacher package ``apt-cacher.client`` - Sets up the device to use the apt-cacher for apt-get packages +--------------------- + + Sets up the system to use the apt-cacher server as the caching proxy