Merge pull request #39 from seegno/enhancement/markdown-readme

Update README to markdown syntax
This commit is contained in:
Wolodja Wentland 2015-02-23 18:56:13 +01:00
commit aa4d6baca6
2 changed files with 37 additions and 50 deletions

37
README.md Normal file
View file

@ -0,0 +1,37 @@
# postgres
It sets up [PostgreSQL](http://www.postgresql.org/).
For the best practises see [salt formulas installation and usage instructions](http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html)
## Available states
#### ``postgres``
Installs the postgresql package.
#### ``postgres.python``
Installs the postgresql python module
## Testing
Testing is done wit kitchen-salt
#### ``kitchen converge``
Runs the postgres main state
#### ``kitchen verify``
Runs serverspec tests on the actual instance
#### ``kitchen test``
Builds and runs test from scratch
#### ``kitchen login``
Gives you ssh to the vagrant machine for manual testing

View file

@ -1,50 +0,0 @@
========
postgres
========
.. note::
See the full `Salt Formulas installation and usage instructions
<http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
Available states
================
.. contents::
:local:
``postgres``
------------
Installs the postgresql package.
``postgres.python``
-------------------
Installs the postgresql python module
Testing
=======
Testing is done wit kitchen-salt
``kitchen converge``
--------------------
Runs the postgres main state
``kitchen verify``
------------------
Runs serverspec tests on the actual instance
``kitchen test``
----------------
Builds and runs test from scratch
``kitchen login``
-----------------
Gives you ssh to the vagrant machine for manual testing