Update documentation and readme

Author: codingjoe

MANIFEST.in

@@ -0,0 +1,24 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/codingjoe/django-select2/raw/main/images/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg">
+    <img alt="Django Select2: Custom autocomplete fields for Django" src="https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg">
+  </picture>
+<br>
+  <a href="https://django-select2.rtfd.io">Documentation</a>
+</p>
+
+# Django-Select2
+
+[![version](https://img.shields.io/pypi/v/Django-Select2.svg)](https://pypi.python.org/pypi/Django-Select2/)
+[![coverage](https://codecov.io/gh/codingjoe/django-select2/branch/main/graph/badge.svg)](https://codecov.io/gh/codingjoe/django-select2)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/codingjoe/django-select2/main/LICENSE.txt)
+
+Custom autocomplete fields for [Django](https://www.djangoproject.com/).
+
+## Documentation
+
+Documentation available at <https://django-select2.rtfd.io>.
+
+> [!NOTE]
+> Django\'s admin comes with builtin support for Select2 via the [autocomplete_fields](https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.autocomplete_fields) feature.

README.md

@@ -24,6 +24,7 @@
 version = ".".join(release.split(".")[:2])
 
 master_doc = "index"  # default in Sphinx v2
+html_theme = "furo"
 
 
 extensions = [

README.rst

@@ -1,4 +1,13 @@
-.. include:: ../README.rst
+Django Select2
+==============
+
+.. image:: https://github.com/codingjoe/django-select2/raw/main/images/logo-light.svg
+   :align: center
+   :class: only-light
+
+.. image:: https://github.com/codingjoe/django-select2/raw/main/images/logo-dark.svg
+   :align: center
+   :class: only-dark
 
 Installation
 ------------

SECURITY.md

@@ -7,7 +7,7 @@ name = "django-select2"
 authors = [
   { name = "Johannes Maron", email = "johannes@maron.family" },
 ]
-readme = "README.rst"
+readme = "README.md"
 license = { file = "LICENSE" }
 keywords = ["Django", "select2", "autocomplete", "typeahead"]
 dynamic = ["version", "description"]
@@ -48,6 +48,7 @@ test = [
 ]
 docs = [
   "sphinx",
+  "furo",
 ]
 
 [project.urls]