Documentation improvements

doc/index.rst

@@ -4,19 +4,36 @@
    contain the root `toctree` directive.
 
 Welcome to Flask-RESTX's documentation!
-==========================================
+=======================================
 
 Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs.
 Flask-RESTX encourages best practices with minimal setup.
 If you are familiar with Flask, Flask-RESTX should be easy to pick up.
 It provides a coherent collection of decorators and tools to describe your API
 and expose its documentation properly (using Swagger).
 
+Flask-RESTX is a community driven fork of `Flask-RESTPlus
+<https://github.com/noirbizarre/flask-restplus>`_
+
+
+Why did we fork?
+================
+
+The community has decided to fork the project due to lack of response from the
+original author @noirbizarre. We have been discussing this eventuality for
+`a long time <https://github.com/noirbizarre/flask-restplus/issues/593>`_.
+
+Things evolved a bit since that discussion and a few of us have been granted
+maintainers access to the github project, but only the original author has
+access rights on the PyPi project. As such, we been unable to make any actual
+releases. To prevent this project from dying out, we have forked it to continue
+development and to support our users.
+
 
 Compatibility
 =============
 
-flask-restx requires Python 2.7+.
+flask-restx requires Python 2.7+ or 3.4+.
 
 
 Installation

doc/quickstart.rst

@@ -10,6 +10,29 @@ and that you have already installed both Flask and Flask-RESTX.
 If not, then follow the steps in the :ref:`installation` section.
 
 
+Migrate from Flask-RESTPlus
+---------------------------
+
+.. warning:: The *migration* commands provided below are for illustration
+             purposes.
+             You may need to adapt them to properly fit your needs.
+             We also recommend you make a backup of your project prior running them.
+
+At this point, Flask-RESTX remains 100% compatible with Flask-RESTPlus' API.
+All you need to do is update your requirements to use Flask-RESTX instead of
+Flask-RESTPlus. Then you need to update all your imports.
+This can be done using something like:
+
+::
+   find . -type f -name "*.py" | xargs sed -i "s/flask_restplus/flask_restx/g"
+
+Finally, you will need to update your configuration options (described `here
+<quickstart.html#configuration>`_). Example:
+
+::
+   find . -type f -name "*.py" | xargs sed -i "s/RESTPLUS_/RESTX_/g"
+
+
 Initialization
 --------------