Migrate the complete readme to reStructuredText

README.rst

@@ -1,8 +1,73 @@
+=======================
 Django migration linter
 =======================
 
 Detect backward incompatible migrations for your django project. It will save you time by making sure migrations will not break anything.
 
-`The source and README for this project is available here
-<https://github.com/3YOURMIND/django-migration-linter>`_.
+.. image:: https://travis-ci.org/3YOURMIND/django-migration-linter.svg?branch=master
+    :target: https://travis-ci.org/3YOURMIND/django-migration-linter
 
+.. image:: https://img.shields.io/pypi/v/django-migration-linter.svg
+    :target: https://pypi.python.org/pypi/django-migration-linter/
+
+.. image:: https://img.shields.io/github/license/3yourmind/django-migration-linter.svg
+    :target: ./LICENSE
+
+.. image:: https://img.shields.io/badge/PR-welcome-green.svg
+    :target: https://github.com/3YOURMIND/django-migration-linter/pulls
+
+.. image:: https://img.shields.io/badge/3YOURMIND-Hiring-brightgreen.svg
+    :target: https://www.3yourmind.com/career
+
+.. image:: https://img.shields.io/github/stars/3YOURMIND/django-migration-linter.svg?style=social&label=Stars
+    :target: https://github.com/3YOURMIND/django-migration-linter/stargazers
+
+Installation
+------------
+
+``pip install django-migration-linter``
+
+
+Usage
+-----
+
+``django-migration-linter DJANGO_PROJECT_FOLDER [GIT_COMMIT_ID] [--ignore-name-contains=IGNORE_NAME_CONTAINS] [--include-apps INCLUDE_APPS [INCLUDE_APPS ...] | --exclude-apps EXCLUDE_APPS [EXCLUDE_APPS ...]]``
+
+================================================== ===========================================================================================================================
+                   Parameter                                                                            Description
+================================================== ===========================================================================================================================
+``DJANGO_PROJECT_FOLDER``                          An absolute or relative path to the django project.
+``GIT_COMMIT_ID``                                  If specified, only migrations since this commit will be taken into account. If not specified, all migrations will be linted.
+``--ignore-name-contains IGNORE_NAME_CONTAINS``    Ignore migrations containing this name.
+``--ignore-name IGNORE_NAME [IGNORE_NAME ...]``    Ignore migrations with exactly one of these names.
+``--include-apps INCLUDE_APPS [INCLUDE_APPS ...]`` Check only migrations that are in the specified django apps.
+``--exclude-apps EXCLUDE_APPS [EXCLUDE_APPS ...]`` Ignore migrations that are in the specified django apps.
+``--verbose or -v``                                Print more information during execution.
+``--database DATABASE``                            Specify the database for which to generate the SQL. Defaults to *default*.
+================================================== ===========================================================================================================================
+
+Examples
+--------
+
+3YOURMIND is running the linter on `Bitbucket Pipelines`_ on every build getting pushed.
+
+Tests
+-----
+
+The easiest way to run the tests is to invoke `tox`_.
+
+Contributing
+------------
+
+First, thank you very much if you want to contribute to the project.
+Please base your work on the ``dev`` branch and also target this branch in your pull request.
+
+License
+-------
+
+*django-migration-linter* is released under the `Apache 2.0 License`_.
+
+
+.. _`Bitbucket Pipelines`: https://bitbucket.org/product/features/pipelines
+.. _`tox`: https://pypi.python.org/pypi/tox
+.. _`Apache 2.0 License`: https://github.com/3YOURMIND/django-migration-linter/blob/master/LICENSE