Skip to content

Commit 1372d22

Browse files
chore(release): de-duplicate the README Install section (v1 polish)
The README had two `## Install` snippets: the top (correct, two `INSTALLED_APPS` entries + one URL include) and a later one that was stale (only `django_admin_react`, mounted at `/admin/` which would collide with `django.contrib.admin`). Replaced the lower section with a short pointer back to the top — fewer divergent paths, no collision-inducing example.
1 parent 5e4ceac commit 1372d22

1 file changed

Lines changed: 10 additions & 28 deletions

File tree

README.md

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -103,34 +103,16 @@ emails, account numbers, or PII).
103103
pip install django-admin-react
104104
```
105105

106-
```python
107-
# settings.py
108-
INSTALLED_APPS = [
109-
"django.contrib.admin",
110-
"django.contrib.auth",
111-
"django.contrib.contenttypes",
112-
"django.contrib.sessions",
113-
"django.contrib.messages",
114-
"django.contrib.staticfiles",
115-
"django_admin_react", # ← add this
116-
# ... your own apps
117-
]
118-
```
119-
120-
```python
121-
# urls.py
122-
from django.urls import include, path
123-
124-
urlpatterns = [
125-
path("admin/", include("django_admin_react.urls")),
126-
# any prefix is fine:
127-
# path("admin-react/", include("django_admin_react.urls")),
128-
# path("staff/", include("django_admin_react.urls")),
129-
]
130-
```
131-
132-
That is the entire integration. Log in as a staff user → modern,
133-
Tailwind-styled SPA driven by your existing `ModelAdmin` classes.
106+
This pulls in the JSON API ([`django-admin-rest-api`](https://pypi.org/project/django-admin-rest-api/))
107+
and the MCP adapter ([`django-admin-mcp-api`](https://pypi.org/project/django-admin-mcp-api/))
108+
as transitive dependencies. The **two-line `INSTALLED_APPS` + one-line
109+
URL include** at the top of this README is the *entire* integration.
110+
Mount at any prefix you like — `/admin-react/`, `/staff/`,
111+
`/back-office/` — just don't collide with `django.contrib.admin`'s
112+
own mount.
113+
114+
Log in as a staff user → modern, Tailwind-styled SPA driven by your
115+
existing `ModelAdmin` classes.
134116

135117
The wheel ships the **pre-built React bundle**. You do **not** need
136118
Node, pnpm, or any frontend toolchain to install or run.

0 commit comments

Comments
 (0)