feat: improvements, next release (#5)

* feat: change dev project and README.md * feat: add title to results.html * docs: add screenshots --------- Signed-off-by: Stanislav Filin <[email protected]>
stasfilin · Feb 10, 2024 · 152f0ee · 152f0ee
1 parent 7c4f476
commit 152f0ee
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 ## Introduction
 This Django application introduces a GlobalSearchView, designed to perform a global search across various models within the Django admin site.
+![alt text](assets/main.png "Main Page")
+![alt text](assets/results.png "Results Page")
 
 ## Features
 * Global Search: Enables searching across multiple models from a single query.
@@ -19,7 +21,16 @@ Install with command `pip install django-admin-global-search`.
 
 ### Usage
 To use `django-admin-global-search` in your Django project, you need to update your models and URL configurations.
-1. Add `admin_global_search` to your `INSTALLED_APPS` setting.
+1. Add `admin_global_search` to your `INSTALLED_APPS` setting before `django.contrib.admin`.
+```python
+INSTALLED_APPS = [
+    "admin_global_search",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    ...
+]
+```
 2. Ensure your models have a `global_search_fields` attribute that specifies the fields to be included in the search. Example:
 ```python
 class Artist(models.Model):

diff --git a/admin_global_search/templates/admin_global_search/results.html b/admin_global_search/templates/admin_global_search/results.html
@@ -25,6 +25,8 @@
 </style>
 {% endblock %}
 
+{% block title %}Results for "{{ query }}" | {{ site_title|default:_('Django site admin') }}{% endblock %}
+
 {% block content %}
 <div class="admin-global-search-results">
   <h1>{% trans "Search Results" %}</h1>

diff --git a/assets/main.png b/assets/main.png
diff --git a/assets/results.png b/assets/results.png
diff --git a/dev/dev/settings.py b/dev/dev/settings.py
@@ -31,14 +31,14 @@
 # Application definition
 
 INSTALLED_APPS = [
+    "admin_global_search",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "music",
-    "admin_global_search",
 ]
 
 MIDDLEWARE = [

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-admin-global-search"
-version = "0.0.1"
+version = "0.0.2"
 description = "A global search for Django Admin UI"
 authors = ["Stanislav Filin <[email protected]>"]
 license = "BSD 3-Clause License"