Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncee committed Jun 22, 2015
1 parent d6b0d76 commit 481e506
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
22 changes: 14 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ Project aims to support **Python 2.7**, **3.3** and **3.4**,
**Django 1.6**, **1.7** and **1.8**.


.. WARNING::

Version 1.3 introduced backward incompatible
changes. Read more in changelog_.

Also, ``Select2`` library was upgraded from **3.4**
to **4.0.0**. If you are tied to older version, please, use
``django-easy-select2 1.2.13``.


How it looks
------------

Expand All @@ -22,18 +32,12 @@ Select one of existing values with single-valued choice field
:target: https://github.com/asyncee/django-easy-select2/raw/master/screenshots/select2_single.png

Easily select 1 or more "categories" for your project, you can also
add a new one in the normal, Django-Admin manner by using the green + button
with multiple-valued choice field (ManyToManyField):
add a new one in the normal, Django-Admin manner by using the
green + button with multiple-valued choice field (ManyToManyField):

.. image:: https://github.com/asyncee/django-easy-select2/raw/master/screenshots/select2_multiple.png
:target: https://github.com/asyncee/django-easy-select2/raw/master/screenshots/select2_multiple.png

Don't see the "mood" you want? No problem, just type in a new one.
It will be there as a choice for the next time too (text input).

.. image:: https://github.com/asyncee/django-easy-select2/raw/master/screenshots/select2_text_input.png
:target: https://github.com/asyncee/django-easy-select2/raw/master/screenshots/select2_text_input.png


Quickstart
----------
Expand All @@ -59,6 +63,8 @@ You can read more in the documentation_.

.. _documentation: http://django-easy-select2.readthedocs.org

.. _changelog: http://django-easy-select2.readthedocs.org/en/latest/changelog.html

.. |pypi| image:: https://img.shields.io/pypi/v/django-easy-select2.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-easy-select2
:alt: pypi
Expand Down
2 changes: 1 addition & 1 deletion docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Version 1.3
Version 1.3 introduced backward incompatible changes, read below.

- `Select2` updated to 4.0.0
- updated jquery to 2.1.3
- updated `jQuery` to 2.1.3
- removed deprecated `select2_meta_factory`, `Select2TextMixin` and
`Select2TextInput`.

Expand Down
Binary file modified screenshots/select2_multiple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/select2_single.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 481e506

Please sign in to comment.