You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+57-13Lines changed: 57 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,22 +21,66 @@ High-flying components for perfectionists with deadlines.
21
21
22
22
1. Install the package from PyPI:
23
23
24
-
```bash
25
-
python -m pip install django-bird
26
-
# or
27
-
uv add django-bird
28
-
uv sync
29
-
```
24
+
```bash
25
+
python -m pip install django-bird
26
+
27
+
# or if you like the new hotness
28
+
29
+
uv add django-bird
30
+
uv sync
31
+
```
30
32
31
33
2. Add the app to your Django project's `INSTALLED_APPS`:
32
34
33
-
```python
34
-
INSTALLED_APPS= [
35
-
...,
36
-
"django_bird",
37
-
...,
38
-
]
39
-
```
35
+
```python
36
+
INSTALLED_APPS = [
37
+
...,
38
+
"django_bird",
39
+
...,
40
+
]
41
+
```
42
+
43
+
3. django-bird requires two settings in your `settings.TEMPLATES` to be configured to work properly:
44
+
45
+
- `django_bird.templatetags.django_bird` in the `builtins`
46
+
- `django_bird.loader.BirdLoader` in the innermost list of `loaders`, before `django.template.loaders.filesystem.Loader` and `django.template.loaders.app_directories.Loader`
47
+
48
+
By default, these should be configured for you automatically. If you would like to disable this behavior and set this up yourself, you will need to set `DJANGO_BIRD["ENABLE_AUTO_CONFIG"] = False`.
0 commit comments