Skip to content

Commit ce3a6b0

Browse files
Update README.md
1 parent c50decc commit ce3a6b0

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,33 @@ First, install the package. This will also install plotly and some dash packages
2727

2828
pip install django_plotly_dash
2929

30-
Then, just add `django_plotly_dash` to `INSTALLED_APPS` in your Django `settings.py` file
30+
Then, add `django_plotly_dash` to `INSTALLED_APPS` in your Django `settings.py` file
3131

3232
INSTALLED_APPS = [
3333
...
3434
'django_plotly_dash.apps.DjangoPlotlyDashConfig',
3535
...
3636
]
3737

38+
The application's routes need to be registered within the routing structure by an appropriate ``include`` statement in
39+
a ``urls.py`` file::
40+
41+
urlpatterns = [
42+
...
43+
path('django_plotly_dash/', include('django_plotly_dash.urls')),
44+
]
45+
46+
The name within the URL is not important and can be changed.
47+
48+
For the final installation step, a migration is needed to update the
49+
database::
50+
51+
./manage.py migrate
52+
3853
Note that this package requires version 2.0 or greater of Django, due to the use of the `path` function for registering routes.
3954

40-
Live updating of applications, to share application
41-
state, requires further
42-
configuration. See the [online documentation](https://django-plotly-dash.readthedocs.io/en/latest/) for more details.
55+
Further configuration, including live updating to share application
56+
state, is described in the [online documentation](https://django-plotly-dash.readthedocs.io/en/latest/).
4357

4458
## Demonstration
4559

0 commit comments

Comments
 (0)