===========
Get Started
===========

Overview
--------

.. automodule:: linked_select2
    :members:

Installation
------------

1. Install ``linked_select2`` and ``django_select2``::

        ... TODO: finish ...
        pip install django_select2

2. Add ``linked_select2`` (and ``django_select2`` if you're going to use its
functionality too) to your ``INSTALLED_APPS`` in your project settings.
``linked_select2`` should always be declared **before** ``django_select2``
(in order to increase priority of .js files from this app).

3. Add ``linked_select2`` to your ``urlconf`` **if** you use any
:class:`ModelWidgets <.linked_select2.forms.LinkedModelSelect2Mixin>`::

        url(r'^select2/', include('linked_select2.urls')),


External Dependencies
---------------------

* jQuery version 2
    This is not included in the package since it is expected
    that in most scenarios this would already be available.