docs(readme): update readme, add badges

README.rst → docs/README.rst

@@ -1,25 +1,58 @@
-======
-Vault
-======
+.. _readme:
+
+vault-formula
+=============
+
+|img_travis| |img_sr|
 
-.. image:: https://travis-ci.org/saltstack-formulas/vault-formula.svg?branch=master
+.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/vault-formula.svg?branch=master
+   :alt: Travis CI Build Status
+   :scale: 100%
+   :target: https://travis-ci.com/saltstack-formulas/vault-formula
+.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+   :alt: Semantic Release
+   :scale: 100%
+   :target: https://github.com/semantic-release/semantic-release
 
 Formulas for working with `Vault <http://www.vaultproject.io>`_
 
+.. contents:: **Table of Contents**
+
+General notes
+-------------
+
+See the full `SaltStack Formulas installation and usage instructions
+<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
+
+If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
+<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.
+
+If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
+which contains the currently released version. This formula is versioned according to `Semantic Versioning <http://semver.org/>`_.
+
+See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
+
+Contributing to this repo
+-------------------------
+
+**Commit message formatting is significant!!**
+
+Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
+
 Available states
 ================
 
 .. contents::
     :local:
 
 ``vault``
-----------
+---------
 
 Install the vault binary
 
 
 ``vault.server``
----------------------
+----------------
 
 Install and configure the vault server