Skip to content

Commit 3f00d3d

Browse files
committed
Fix #36: Mention the supported Django versions in the README
1 parent 02b4559 commit 3f00d3d

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

README.rst

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,36 @@ django-translated-fields
88

99
Django model translation without magic-inflicted pain.
1010

11+
Installation
12+
============
1113

12-
Installation and usage
13-
======================
14+
Install the package into your virtualenv::
1415

15-
After installing ``django-translated-fields`` in your Python
16-
environment all you have to do is define ``LANGUAGES`` in your
17-
settings and add translated fields to your models:
16+
pip install django-translated-fields
17+
18+
Add the package to your ``INSTALLED_APPS``:
19+
20+
.. code-block:: python
21+
22+
INSTALLED_APPS = [
23+
*INSTALLED_APPS,
24+
"translated_fields",
25+
]
26+
27+
django-translated-fields supports all versions of Django from 3.2 to 5.1. If in
28+
doubt, check the test runs in the GitHub actions environment.
29+
30+
31+
Usage
32+
=====
33+
34+
You should define the `the list of languages your project supports in your
35+
settings first
36+
<https://docs.djangoproject.com/en/5.0/ref/settings/#languages>`__ by defining
37+
``LANGUAGES``. Otherwise, you'll get fields for all the dozens of languages
38+
Django supports out of the box.
39+
40+
Next, add translated fields to your models:
1841

1942
.. code-block:: python
2043

tox.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
envlist =
33
py{38,39,310}-dj{32,41,42}
44
py{310,311}-dj{32,41,42,50,main}
5-
py{312}-dj{42,50,main}
5+
py{312}-dj{42,50,51,main}
66
docs
77

88
[testenv]
@@ -19,6 +19,7 @@ deps =
1919
dj41: Django>=4.1,<4.2
2020
dj42: Django>=4.2,<5.0
2121
dj50: Django>=5.0,<5.1
22+
dj51: Django>=5.1rc1,<5.2
2223
djmain: https://github.com/django/django/archive/main.zip
2324

2425
[testenv:docs]

0 commit comments

Comments
 (0)