Skip to content

Commit 2f8b0ad

Browse files
committed
Document need for INSTALLED_APPS
Fixes #54
1 parent a24e53d commit 2f8b0ad

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ python -m pip install django-tasks
2222

2323
### Settings
2424

25-
The first step is to configure a backend. This connects the tasks to whatever is going to execute them.
25+
The first step is to add `django_tasks` to your `INSTALLED_APPS`.
26+
27+
Secondly, you'll need to configure a backend. This connects the tasks to whatever is going to execute them.
2628

2729
If omitted, the following configuration is used:
2830

@@ -36,9 +38,11 @@ TASKS = {
3638

3739
A few backends are included by default:
3840

39-
- `DummyBackend`: Don't execute the tasks, just store them. This is especially useful for testing.
40-
- `ImmediateBackend`: Execute the task immediately in the current thread
41-
- `DatabaseBackend`: Store tasks in the database (via Django's ORM), and retrieve and execute them using the `db_worker` management command
41+
- `django_tasks.backends.dummy.DummyBackend`: Don't execute the tasks, just store them. This is especially useful for testing.
42+
- `django_tasks.backends.immediate.ImmediateBackend`: Execute the task immediately in the current thread
43+
- `django_tasks.backends.database.DatabaseBackend`: Store tasks in the database (via Django's ORM), and retrieve and execute them using the `db_worker` management command
44+
45+
Note: `DatabaseBackend` additionally requires `django_tasks.backends.database` adding to `INSTALLED_APPS`.
4246

4347
### Defining tasks
4448

0 commit comments

Comments
 (0)