Skip to content

Commit dce549f

Browse files
committed
Improve doumentation
1 parent a1d2c15 commit dce549f

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,19 @@ Django Mail Auth features:
1818
- drop in Django User replacement
1919
- extendable SMS support
2020

21-
This project was originally inspired by `Is it time for password-less login?`__ by `Ben Brown`_.
21+
This project was inspired by:
2222

23-
__ http://notes.xoxco.com/post/27999787765/is-it-time-for-password-less-login
23+
- `Is it time for password-less login?`_ by `Ben Brown`_
24+
- `LOGIN WITHOUT PASSWORD MOST SECURE | WAIT.. WHAT?`_ by `Joris Snoek`_
25+
- `django-nopassword`_ by `Rolf Erik Lekang`_
26+
27+
28+
.. _`Rolf Erik Lekang`: http://rolflekang.com
29+
.. _`django-nopassword`: https://github.com/relekang/django-nopassword
30+
.. _`Is it time for password-less login?`: http://notes.xoxco.com/post/27999787765/is-it-time-for-password-less-login
31+
.. _`LOGIN WITHOUT PASSWORD MOST SECURE | WAIT.. WHAT?`: https://www.lucius.digital/en/blog/login-without-password-most-secure-wait-what
2432
.. _`Ben Brown`: http://twitter.com/benbrown
33+
.. _`Joris Snoek`: https://twitter.com/lucius_digital
2534

2635
Installation
2736
------------
@@ -41,7 +50,7 @@ First add `mailauth` to you installed apps::
4150

4251
'mailauth',
4352
'mailauth.contrib.admin', # optional
44-
'mailauth.contrib.auth', # optional
53+
'mailauth.contrib.user', # optional
4554

4655
# other apps…
4756
]
@@ -58,7 +67,8 @@ Next you will need to add the new authentication backend::
5867

5968
AUTHENTICATION_BACKENDS = (
6069
# default, but now optional
61-
# This should be removed if
70+
# This should be removed if you use mailauth.contrib.user or any other
71+
# custom user model that does not have a username/password
6272
'django.contrib.auth.backends.ModelBackend',
6373

6474
# The new access token based authentication backend

0 commit comments

Comments
 (0)