From aae7f25e1f1f87b902690b63f3d3c24cb576ab43 Mon Sep 17 00:00:00 2001 From: Forrest Alvarez Date: Tue, 7 Jan 2014 05:31:26 +0000 Subject: [PATCH] updated the README to adhere to standards. --- README.rst | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 37669a1..ff9d3c7 100644 --- a/README.rst +++ b/README.rst @@ -2,11 +2,29 @@ openssh ======= Install and configure an openssh server. -States ------- +.. note:: + + See the full `Salt Formulas installation and usage instructions + `_. + +Available states +================ + +.. contents:: + :local: + ``openssh`` - Installs the ``openssh`` package and service. +----------- + +Installs the ``openssh`` package and service. + ``openssh.config`` - Installs the configuration file included in this formula (under "openssh/files"). +------------------ + +Installs the configuration file included in this formula +(under "openssh/files"). + ``openssh.banner`` - Installs a banner that users see when SSH-ing in. +------------------ + +Installs a banner that users see when SSH-ing in.