diff --git a/README.md b/README.md new file mode 100644 index 0000000..b9c715a --- /dev/null +++ b/README.md @@ -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 + diff --git a/README.rst b/README.rst deleted file mode 100644 index a3077ae..0000000 --- a/README.rst +++ /dev/null @@ -1,50 +0,0 @@ -======== -postgres -======== - -.. note:: - - See the full `Salt Formulas installation and usage instructions - `_. - -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 -