updated the README to adhere to standards.

This commit is contained in:
Forrest Alvarez 2014-01-07 05:31:26 +00:00
parent 531a68c4b9
commit aae7f25e1f
1 changed files with 23 additions and 5 deletions

View File

@ -2,11 +2,29 @@ openssh
=======
Install and configure an openssh server.
States
------
.. note::
See the full `Salt Formulas installation and usage instructions
<http://docs.saltstack.com/topics/conventions/formulas.html>`_.
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.