Adopt main README for version 2.0

Author: jrief

README.md

@@ -1,6 +1,7 @@
 # django-admin-sortable2
 
-A replacement for django-admin-sortable using an unintrusive approach.
+This Django package adds functionality for generic drag-and-drop ordering of items in the List, the Stacked- and the
+Tabular-Inlines Views of the Django Admin interface.
 
 [![Build Status](https://github.com/jrief/django-admin-sortable2/actions/workflows/django.yml/badge.svg)](https://github.com/jrief/django-admin-sortable2/actions/workflows/django.yml)
 [![PyPI version](https://img.shields.io/pypi/v/django-admin-sortable2.svg)](https://pypi.python.org/pypi/django-admin-sortable2)
@@ -9,42 +10,40 @@ A replacement for django-admin-sortable using an unintrusive approach.
 [![Downloads](https://img.shields.io/pypi/dm/django-admin-sortable2.svg)](https://img.shields.io/pypi/dm/django-admin-sortable2.svg)
 [![Software license](https://img.shields.io/pypi/l/django-admin-sortable2.svg)](https://github.com/jrief/django-admin-sortable2/blob/master/LICENSE)
 
-This plugin is a generic drag-and-drop ordering module for sorting objects in the List, the Stacked-
-and the Tabular-Inlines Views in the Django Admin interface.
+Check the demo:
 
-![Demo](https://raw.githubusercontent.com/jrief/django-admin-sortable2/master/demo.gif)
+![Demo](https://raw.githubusercontent.com/jrief/django-admin-sortable2/master/docs/source/_static/django-admin-sortable2.gif)
 
-This module offers simple mixin classes which enrich the functionality of any existing class derived
-from `admin.ModelAdmin`, `admin.StackedInline` or `admin.TabularInline`.
+This library offers simple mixin classes which enrich the functionality of any existing class inheriting from
+`admin.ModelAdmin`, `admin.StackedInline` or `admin.TabularInline`.
 
-Thus it makes it very easy to integrate with existing models and their model admin interfaces.
-Existing models can inherit from `models.Model` or any other class derived thereof. No special
-base class is required.
+It thus makes it very easy to integrate with existing models and their model admin interfaces. Existing models can
+inherit from `models.Model` or any other class derived thereof. No special base class is required.
 
 
-## Project's home
+## Version 2.0
 
-https://github.com/jrief/django-admin-sortable2
+This is a major rewrite of this **django-admin-sortable2**. It replaces the client side part against
+[Sortable.JS](https://sortablejs.github.io/Sortable/) and thus the need for jQuery.
 
-Detailled documentation on [ReadTheDocs](http://django-admin-sortable2.readthedocs.org/en/latest/).
+Replacing that library allowed me to add a new feature: Multiple items can now be dragged and dropped together.
 
-To ask questions or reporting bugs, please use the [issue tracker](https://github.com/jrief/django-admin-sortable2/issues).
 
+## Project's Home
 
-## Why should You use it?
+https://github.com/jrief/django-admin-sortable2
 
-All available plugins which add functionality to make list views for the Django admin interface
-sortable, offer a base class to be used instead of `models.Model`. This abstract base class then
-contains a hard coded position field, additional methods, and meta directives.
+Detailled documentation can be found on [ReadTheDocs](https://django-admin-sortable2.readthedocs.org/en/latest/).
 
-This inhibits to create sortable abstract models. **django-admin-sortable2** does not have these
-restrictions.
+To ask questions or reporting bugs, please read the [contributor's guide](https://django-admin-sortable2.readthedocs.io/en/latest/contributing.html).
 
 
 ## License
 
-MIT licensed.
+Licensed under the terms of the MIT license.
 
-Copyright © 2013-2021 Jacob Rief and contributors.
+Copyright © 2013-2022 Jacob Rief and contributors.
 
+Please follow me on
 [![Twitter Follow](https://img.shields.io/twitter/follow/jacobrief.svg?style=social&label=Jacob+Rief)](https://twitter.com/jacobrief)
+for updates and other news.

docs/source/contributing.rst

@@ -98,11 +98,15 @@ that such a feature is merged.
 
 You can use that extra code to adopt the test suite.
 
-Remember: For UI-centric applications such as this one, where the client- and server-side are
+*Remember*: For UI-centric applications such as this one, where the client- and server-side are
 strongly entangled with each other, I prefer end-to-end tests way more rather than unit tests.
 Reason is, that otherwise I would have to mock the interfaces, which itself is error-prone and
 additional work.
 
+*Don't hide yourself*: I will not accept large pull requests from anonymous users, so please publish
+an email address in your GitHub's profile. Reason is that when refactoring the code, I must be
+able to contact the initial author of a feature not added by myself.
+
 
 Quoting
 =======

setup.py

@@ -45,7 +45,7 @@ def readfile(filename):
     install_requires=[
         'Django>=4.0',
     ],
-    packages=find_packages(exclude=['testapp', 'docs']),
+    packages=find_packages(exclude=['client', 'testapp', 'docs']),
     include_package_data=True,
     zip_safe=False,
 )