Skip to content

Commit 86a301b

Browse files
authored
Update README.rst
1 parent 3ad7a96 commit 86a301b

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Django Qsessions
55
django-qsessions is a session backend for Django that extends Django's ``cached_db`` session backend
66
and ``Session`` model to add following features:
77

8-
* Sessions have a foreign key to User
9-
* Sessions store IP and User Agent
8+
- Sessions have a foreign key to User
9+
10+
- Sessions store IP and User Agent
1011

1112
Installation
1213
============
@@ -26,13 +27,13 @@ using another session backend, you need to migrate sessions manually.
2627
2728
(3) In settings:
2829

29-
- In ``INSTALLED_APPS`` replace ``'django.contrib.sessions'`` with ``'qsessions'``.
30+
- In ``INSTALLED_APPS`` replace ``'django.contrib.sessions'`` with ``'qsessions'``.
3031

31-
- In ``MIDDLEWARE`` or ``MIDDLEWARE_CLASSES`` replace
32-
``'django.contrib.sessions.middleware.SessionMiddleware'`` with
33-
``'qsessions.middleware.SessionMiddleware'``.
32+
- In ``MIDDLEWARE`` or ``MIDDLEWARE_CLASSES`` replace
33+
``'django.contrib.sessions.middleware.SessionMiddleware'`` with
34+
``'qsessions.middleware.SessionMiddleware'``.
3435

35-
- Add ``SESSION_ENGINE = 'qsessions.backends.cached_db'``.
36+
- Add ``SESSION_ENGINE = 'qsessions.backends.cached_db'``.
3637

3738
(4) Run migrations to create ``qsessions.models.Session`` model.
3839

@@ -74,10 +75,13 @@ TODO
7475
====
7576

7677
- Write better documentation.
77-
- Explain how it works (in summary)
78-
- Explain how to query sessions based on users, and delete sessions
79-
- Add more details to existing documentation.
78+
79+
- Explain how it works (in summary)
80+
- Explain how to query sessions based on users, and delete sessions
81+
- Add more details to existing documentation.
82+
8083
- Write tests (for latest Python and Django versions)
84+
8185
- Performance benchmark (and compare with Django's `cached_db`)
8286

8387
Contributions are welcome!
@@ -89,4 +93,4 @@ MIT
8993

9094
.. _`configured your cache`: https://docs.djangoproject.com/en/dev/topics/cache/
9195
.. _`django-user-sessions`: https://github.com/Bouke/django-user-sessions
92-
.. _`Bouke Haarsma`: https://github.com/Bouke
96+
.. _`Bouke Haarsma`: https://github.com/Bouke

0 commit comments

Comments
 (0)